From 1a31c56858fba6f66f3a2ebcc54faecbe3827e67 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:34 +0000 Subject: [PATCH 01/41] chore: update docs/dyn/index.md --- docs/dyn/index.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/dyn/index.md b/docs/dyn/index.md index 2a2282e96f..2dcddc814e 100644 --- a/docs/dyn/index.md +++ b/docs/dyn/index.md @@ -836,6 +836,7 @@ ## integrations * [v1](http://googleapis.github.io/google-api-python-client/docs/dyn/integrations_v1.html) +* [v2](http://googleapis.github.io/google-api-python-client/docs/dyn/integrations_v2.html) ## jobs From 8457bb3f323daa3e4b4d0efb4a1ecba66d52cd25 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:34 +0000 Subject: [PATCH 02/41] fix(admin): update the api #### admin:reports_v1 The following keys were changed: - resources.activities.methods.list.parameters.applicationName.pattern (Total Keys: 1) --- docs/dyn/admin_reports_v1.activities.html | 1 + .../discovery_cache/documents/admin.reports_v1.json | 10 ++++++---- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/docs/dyn/admin_reports_v1.activities.html b/docs/dyn/admin_reports_v1.activities.html index 2c91449553..69fb526c14 100644 --- a/docs/dyn/admin_reports_v1.activities.html +++ b/docs/dyn/admin_reports_v1.activities.html @@ -141,6 +141,7 @@

Method Details

voice - The Voice application's activity reports return information about various types of Voice activity events. chrome_sync - The Chrome Sync application's activity reports return information about various types of Chrome Sync activity events. workspace_studio - The Workspace Studio application's activity reports return information about various types of Workspace Studio activity events. + gemini_notebook - The Gemini Notebook application's activity reports return information about various types of Gemini Notebook activity events. actorIpAddress: string, The Internet Protocol (IP) Address of host where the event was performed. This is an additional way to filter a report's summary using the IP address of the user whose activity is being reported. This IP address may or may not reflect the user's physical location. For example, the IP address can be the user's proxy server's address or a virtual private network (VPN) address. This parameter supports both IPv4 and IPv6 address versions. agentInfoFilter: string, Optional. Filters on agent info fields in the activity. This filter gets applied in conjunction(AND) with other filters. Example: "agentInfoFilter=agentId=\"agent-id\" AND agentName=\"agent-name\" AND agentOwnerEmail=\"agent-owner-email\"" applicationInfoFilter: string, Optional. Used to filter on the `oAuthClientId` field present in [`ApplicationInfo`](#applicationinfo) message. **Usage** ``` GET...&applicationInfoFilter=oAuthClientId="clientId" GET...&applicationInfoFilter=oAuthClientId=%22clientId%22 ``` diff --git a/googleapiclient/discovery_cache/documents/admin.reports_v1.json b/googleapiclient/discovery_cache/documents/admin.reports_v1.json index 74dac87ead..43335d5266 100644 --- a/googleapiclient/discovery_cache/documents/admin.reports_v1.json +++ b/googleapiclient/discovery_cache/documents/admin.reports_v1.json @@ -179,7 +179,8 @@ "graduation", "voice", "chrome_sync", -"workspace_studio" +"workspace_studio", +"gemini_notebook" ], "enumDescriptions": [ "The Google Workspace Access Transparency activity reports return information about different types of Access Transparency activity events.", @@ -222,10 +223,11 @@ "The Graduation application's activity reports return information about various types of Graduation activity events.", "The Voice application's activity reports return information about various types of Voice activity events.", "The Chrome Sync application's activity reports return information about various types of Chrome Sync activity events.", -"The Workspace Studio application's activity reports return information about various types of Workspace Studio activity events." +"The Workspace Studio application's activity reports return information about various types of Workspace Studio activity events.", +"The Gemini Notebook application's activity reports return information about various types of Gemini Notebook activity events." ], "location": "path", -"pattern": "(access_evaluation)|(access_transparency)|(admin)|(admin_data_action)|(assignments)|(calendar)|(chat)|(chrome)|(classroom)|(cloud_search)|(contacts)|(context_aware_access)|(data_studio)|(data_migration)|(directory_sync)|(drive)|(gcp)|(gmail)|(gplus)|(graduation)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(ldap)|(login)|(meet)|(meet_hardware)|(mobile)|(profile)|(rules)|(saml)|(token)|(user_accounts)|(vault)|(gemini_in_workspace_apps)|(tasks)|(takeout)|(voice)|(chrome_sync)|(workspace_studio)", +"pattern": "(access_evaluation)|(access_transparency)|(admin)|(admin_data_action)|(assignments)|(calendar)|(chat)|(chrome)|(classroom)|(cloud_search)|(contacts)|(context_aware_access)|(data_studio)|(data_migration)|(directory_sync)|(drive)|(gcp)|(gmail)|(gplus)|(graduation)|(groups)|(groups_enterprise)|(jamboard)|(keep)|(ldap)|(login)|(meet)|(meet_hardware)|(mobile)|(profile)|(rules)|(saml)|(token)|(user_accounts)|(vault)|(gemini_in_workspace_apps)|(tasks)|(takeout)|(voice)|(chrome_sync)|(workspace_studio)|(gemini_notebook)", "required": true, "type": "string" }, @@ -702,7 +704,7 @@ } } }, -"revision": "20260823", +"revision": "20260929", "rootUrl": "https://admin.googleapis.com/", "schemas": { "Activities": { From 5ab03cf420731e77ba68b4d0fb1e2a75da6a7cf6 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:34 +0000 Subject: [PATCH 03/41] feat(agentidentity): update the api #### agentidentity:v1 The following keys were added: - resources.projects.resources.locations.resources.authProviders.resources.authorizations.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.authProviders.resources.authorizations.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.authProviders.resources.authorizations.methods.testIamPermissions (Total Keys: 12) #### agentidentity:v1alpha The following keys were added: - resources.projects.resources.locations.resources.authProviders.methods.resolveAuthorization (Total Keys: 12) - schemas.AgentIdentityPool (Total Keys: 2) - schemas.AuthProviderTypeParams.properties.connectorReferenceAuthProvider.$ref (Total Keys: 1) - schemas.AuthProviderTypeParams.properties.xaaAuthProvider.$ref (Total Keys: 1) - schemas.ClientAssertionJwtAuth (Total Keys: 3) - schemas.ClientSecretAuth (Total Keys: 4) - schemas.ConnectorReferenceAuthProvider (Total Keys: 6) - schemas.CrossAppAccessAuthProvider (Total Keys: 11) - schemas.CustomIssuer (Total Keys: 3) - schemas.DirectIdJagInput (Total Keys: 2) - schemas.GoogleAccount (Total Keys: 2) - schemas.IdTokenProcessingConfig (Total Keys: 6) - schemas.ResolveAuthorizationRequest (Total Keys: 3) - schemas.ResolveAuthorizationResponse (Total Keys: 3) - schemas.WorkforceIdentityFederation (Total Keys: 2) #### agentidentity:v1beta The following keys were added: - resources.projects.resources.locations.resources.authProviders.methods.resolveAuthorization (Total Keys: 12) - resources.projects.resources.locations.resources.authProviders.resources.authorizations.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.authProviders.resources.authorizations.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.authProviders.resources.authorizations.methods.testIamPermissions (Total Keys: 12) - schemas.AgentIdentityPool (Total Keys: 2) - schemas.AuthProviderTypeParams.properties.connectorReferenceAuthProvider.$ref (Total Keys: 1) - schemas.AuthProviderTypeParams.properties.xaaAuthProvider.$ref (Total Keys: 1) - schemas.ClientAssertionJwtAuth (Total Keys: 3) - schemas.ClientSecretAuth (Total Keys: 4) - schemas.ConnectorReferenceAuthProvider (Total Keys: 6) - schemas.CrossAppAccessAuthProvider (Total Keys: 11) - schemas.CustomIssuer (Total Keys: 3) - schemas.DirectIdJagInput (Total Keys: 2) - schemas.GoogleAccount (Total Keys: 2) - schemas.IdTokenProcessingConfig (Total Keys: 6) - schemas.ResolveAuthorizationRequest (Total Keys: 3) - schemas.ResolveAuthorizationResponse (Total Keys: 3) - schemas.WorkforceIdentityFederation (Total Keys: 2) --- ...ocations.authProviders.authorizations.html | 172 ++++++++ ...lpha.projects.locations.authProviders.html | 371 ++++++++++++++++++ ...ocations.authProviders.authorizations.html | 172 ++++++++ ...beta.projects.locations.authProviders.html | 371 ++++++++++++++++++ .../documents/agentidentity.v1.json | 89 ++++- .../documents/agentidentity.v1alpha.json | 220 ++++++++++- .../documents/agentidentity.v1beta.json | 307 ++++++++++++++- 7 files changed, 1695 insertions(+), 7 deletions(-) diff --git a/docs/dyn/agentidentity_v1.projects.locations.authProviders.authorizations.html b/docs/dyn/agentidentity_v1.projects.locations.authProviders.authorizations.html index 88287d1277..6e7fdb13df 100644 --- a/docs/dyn/agentidentity_v1.projects.locations.authProviders.authorizations.html +++ b/docs/dyn/agentidentity_v1.projects.locations.authProviders.authorizations.html @@ -83,12 +83,21 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single authorization.

+

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

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

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

Lists authorizations in a given project and location.

list_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

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

+

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

Method Details

close() @@ -140,6 +149,54 @@

Method Details

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

Method Details

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

Instance Methods

query_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Resolves an authorization for a user on an auth provider, creating one if it does not exist or returning an existing one.

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

Revokes all authorizations for a specific user on an auth provider. This deletes all authorization records associated with the user and auth provider, effectively revoking access across all agents.

@@ -156,6 +159,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -172,6 +183,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -209,6 +250,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -225,6 +274,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -293,6 +372,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -309,6 +396,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -358,6 +475,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -374,6 +499,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -416,6 +571,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -432,6 +595,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -529,6 +722,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -545,6 +746,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -602,6 +833,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -618,6 +857,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -655,6 +924,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -671,6 +948,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -768,6 +1075,32 @@

Method Details

+
+ resolveAuthorization(name, body=None, x__xgafv=None) +
Resolves an authorization for a user on an auth provider, creating one if it does not exist or returning an existing one.
+
+Args:
+  name: string, Required. The name of the auth provider to resolve authorization for. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `ResolveAuthorization`.
+  "clientUserId": "A String", # Required. The user ID of the client for whom the authorization is resolved.
+}
+
+  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 `ResolveAuthorization`.
+  "authorization": "A String", # The resource name of the resolved authorization. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}
+}
+
+
revokeAuthorization(name, body=None, x__xgafv=None)
Revokes all authorizations for a specific user on an auth provider. This deletes all authorization records associated with the user and auth provider, effectively revoking access across all agents.
@@ -937,6 +1270,14 @@ 

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -953,6 +1294,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", diff --git a/docs/dyn/agentidentity_v1beta.projects.locations.authProviders.authorizations.html b/docs/dyn/agentidentity_v1beta.projects.locations.authProviders.authorizations.html index 6268456a4b..8d84aebaa9 100644 --- a/docs/dyn/agentidentity_v1beta.projects.locations.authProviders.authorizations.html +++ b/docs/dyn/agentidentity_v1beta.projects.locations.authProviders.authorizations.html @@ -83,12 +83,21 @@

Instance Methods

get(name, x__xgafv=None)

Gets details of a single authorization.

+

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

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

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

Lists authorizations in a given project and location.

list_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.

+

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

+

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

Method Details

close() @@ -140,6 +149,54 @@

Method Details

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

Method Details

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

Instance Methods

query_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Resolves an authorization for a user on an auth provider, creating one if it does not exist or returning an existing one.

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

Revokes all authorizations for a specific user on an auth provider. This deletes all authorization records associated with the user and auth provider, effectively revoking access across all agents.

@@ -156,6 +159,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -172,6 +183,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -209,6 +250,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -225,6 +274,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -293,6 +372,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -309,6 +396,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -358,6 +475,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -374,6 +499,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -416,6 +571,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -432,6 +595,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -529,6 +722,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -545,6 +746,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -602,6 +833,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -618,6 +857,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -655,6 +924,14 @@

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -671,6 +948,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", @@ -768,6 +1075,32 @@

Method Details

+
+ resolveAuthorization(name, body=None, x__xgafv=None) +
Resolves an authorization for a user on an auth provider, creating one if it does not exist or returning an existing one.
+
+Args:
+  name: string, Required. The name of the auth provider to resolve authorization for. Format: projects/{project}/locations/{location}/authProviders/{auth_provider} (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `ResolveAuthorization`.
+  "clientUserId": "A String", # Required. The user ID of the client for whom the authorization is resolved.
+}
+
+  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 `ResolveAuthorization`.
+  "authorization": "A String", # The resource name of the resolved authorization. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}
+}
+
+
revokeAuthorization(name, body=None, x__xgafv=None)
Revokes all authorizations for a specific user on an auth provider. This deletes all authorization records associated with the user and auth provider, effectively revoking access across all agents.
@@ -937,6 +1270,14 @@ 

Method Details

"apiKey": { # Configuration for API key authentication. # Parameters for API key authentication. "apiKey": "A String", # Optional. Input only. The API key for this auth provider. }, + "connectorReferenceAuthProvider": { # Configuration parameters for the Connector Reference auth provider. # Parameters for Connector Reference authentication. + "authorizationDetails": [ # Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects. + { + "a_key": "", # Properties of the object. + }, + ], + "connector": "A String", # Required. The name of the referenced connector. + }, "geAuthProvider": { # Configuration for Gemini Enterprise authentication. # Parameters for Gemini Enterprise authentication. }, "threeLeggedOauth": { # Configuration for 3-legged OAuth (3LO) authentication. # Parameters for 3-legged OAuth (3LO) authentication. @@ -953,6 +1294,36 @@

Method Details

"clientSecret": "A String", # Optional. Input only. The client secret of the OAuth client. "tokenUrl": "A String", # Optional. The token endpoint of the OAuth client. }, + "xaaAuthProvider": { # Configuration parameters for the Cross-App Access auth provider. # Parameters for Cross-App Access authentication. + "additionalParameters": { # Optional. Additional parameters to be passed to the token endpoint. + "a_key": "A String", + }, + "clientAssertionJwtAuth": { # Configuration for client ID and client assertion JWT authentication. # Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT. + "clientId": "A String", # Required. The client identifier. + }, + "clientSecretAuth": { # Configuration for client ID and client secret authentication. # Option 1: Authenticate using a standard `client_id` and `client_secret`. + "clientId": "A String", # Required. The client identifier. + "clientSecret": "A String", # Required. Input only. The client secret. + }, + "customIssuer": { # Configuration for a custom or third-party authorization server issuer. # Configuration when using a custom or third-party authorization server as the issuer. + "issuer": "A String", # Optional. The issuer identifier of the target Authorization Server. + "tokenUrl": "A String", # Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens. + }, + "googleAccount": { # Configuration for Google Account usage as the issuer. # Configuration when using Google Accounts as the issuer. + }, + "idJagInput": { # Marker message indicating the input is already an ID-JAG, so no fetching is required. # Configuration for when the input is already an ID-JAG. + }, + "idTokenInput": { # Defines how to process an input ID token to obtain an ID-JAG. # Configuration for when the input is an ID token. + "agentIdentityPool": { # Marker message to indicate the managed Agent Identity Pool is used. # Indicates the managed Agent Identity pool should be used to fetch the ID-JAG. + }, + "idJagAdditionalClaims": { # Optional. Optional additional claims to include when fetching an ID-JAG. + "a_key": "", # Properties of the object. + }, + "idJagAuthProvider": "A String", # The resource name of the ID-JAG auth provider. Format: "projects/{project}/locations/{location}/authProviders/{auth_provider}" + }, + "workforceIdentityFederation": { # Configuration for Workforce Identity Federation usage as the issuer. # Configuration when using Workforce Identity Federation as the issuer. + }, + }, }, "blockedScopes": [ # Optional. List of scopes that are blocked from being requested for this auth provider. If a scope appears in this list, it will not be requested, even if it also appears in `allowed_scopes`. `blocked_scopes` takes precedence over `allowed_scopes`. The number of blocked scopes is limited to 200. "A String", diff --git a/googleapiclient/discovery_cache/documents/agentidentity.v1.json b/googleapiclient/discovery_cache/documents/agentidentity.v1.json index 05e1934ef4..5137da1bda 100644 --- a/googleapiclient/discovery_cache/documents/agentidentity.v1.json +++ b/googleapiclient/discovery_cache/documents/agentidentity.v1.json @@ -778,6 +778,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}:getIamPolicy", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.authorizations.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists authorizations in a given project and location.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations", @@ -823,6 +854,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}:setIamPolicy", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.authorizations.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}:testIamPermissions", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.authorizations.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -833,7 +920,7 @@ } } }, -"revision": "20260823", +"revision": "20260924", "rootUrl": "https://agentidentity.googleapis.com/", "schemas": { "AccessSummary": { diff --git a/googleapiclient/discovery_cache/documents/agentidentity.v1alpha.json b/googleapiclient/discovery_cache/documents/agentidentity.v1alpha.json index 739e3f30c2..96ce6c9638 100644 --- a/googleapiclient/discovery_cache/documents/agentidentity.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/agentidentity.v1alpha.json @@ -607,6 +607,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"resolveAuthorization": { +"description": "Resolves an authorization for a user on an auth provider, creating one if it does not exist or returning an existing one.", +"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:resolveAuthorization", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.resolveAuthorization", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the auth provider to resolve authorization for. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1alpha/{+name}:resolveAuthorization", +"request": { +"$ref": "ResolveAuthorizationRequest" +}, +"response": { +"$ref": "ResolveAuthorizationResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "revokeAuthorization": { "description": "Revokes all authorizations for a specific user on an auth provider. This deletes all authorization records associated with the user and auth provider, effectively revoking access across all agents.", "flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:revokeAuthorization", @@ -920,7 +948,7 @@ } } }, -"revision": "20260823", +"revision": "20261001", "rootUrl": "https://agentidentity.googleapis.com/", "schemas": { "AccessSummary": { @@ -939,14 +967,18 @@ "AUTH_PROVIDER_TYPE_THREE_LEGGED_OAUTH", "AUTH_PROVIDER_TYPE_TWO_LEGGED_OAUTH", "AUTH_PROVIDER_TYPE_API_KEY", -"AUTH_PROVIDER_TYPE_GEMINI_ENTERPRISE" +"AUTH_PROVIDER_TYPE_GEMINI_ENTERPRISE", +"AUTH_PROVIDER_TYPE_CROSS_APP_ACCESS", +"AUTH_PROVIDER_TYPE_CONNECTOR_REFERENCE" ], "enumDescriptions": [ "Unspecified auth provider type.", "3-legged OAuth (3LO) auth provider type.", "2-legged OAuth (2LO) auth provider type.", "API key auth provider type.", -"Gemini Enterprise auth provider type." +"Gemini Enterprise auth provider type.", +"Cross-App Access auth provider type.", +"Connector Reference auth provider type." ], "readOnly": true, "type": "string" @@ -1007,6 +1039,12 @@ }, "type": "object" }, +"AgentIdentityPool": { +"description": "Marker message to indicate the managed Agent Identity Pool is used.", +"id": "AgentIdentityPool", +"properties": {}, +"type": "object" +}, "ApiKeyParams": { "description": "Configuration for API key authentication.", "id": "ApiKeyParams", @@ -1159,6 +1197,10 @@ "$ref": "ApiKeyParams", "description": "Parameters for API key authentication." }, +"connectorReferenceAuthProvider": { +"$ref": "ConnectorReferenceAuthProvider", +"description": "Parameters for Connector Reference authentication." +}, "geAuthProvider": { "$ref": "GeminiEnterpriseAuthProviderParams", "description": "Parameters for Gemini Enterprise authentication." @@ -1170,6 +1212,10 @@ "twoLeggedOauth": { "$ref": "TwoLeggedOAuth", "description": "Parameters for 2-legged OAuth (2LO) authentication." +}, +"xaaAuthProvider": { +"$ref": "CrossAppAccessAuthProvider", +"description": "Parameters for Cross-App Access authentication." } }, "type": "object" @@ -1247,6 +1293,117 @@ }, "type": "object" }, +"ClientAssertionJwtAuth": { +"description": "Configuration for client ID and client assertion JWT authentication.", +"id": "ClientAssertionJwtAuth", +"properties": { +"clientId": { +"description": "Required. The client identifier.", +"type": "string" +} +}, +"type": "object" +}, +"ClientSecretAuth": { +"description": "Configuration for client ID and client secret authentication.", +"id": "ClientSecretAuth", +"properties": { +"clientId": { +"description": "Required. The client identifier.", +"type": "string" +}, +"clientSecret": { +"description": "Required. Input only. The client secret.", +"type": "string" +} +}, +"type": "object" +}, +"ConnectorReferenceAuthProvider": { +"description": "Configuration parameters for the Connector Reference auth provider.", +"id": "ConnectorReferenceAuthProvider", +"properties": { +"authorizationDetails": { +"description": "Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects.", +"items": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"connector": { +"description": "Required. The name of the referenced connector.", +"type": "string" +} +}, +"type": "object" +}, +"CrossAppAccessAuthProvider": { +"description": "Configuration parameters for the Cross-App Access auth provider.", +"id": "CrossAppAccessAuthProvider", +"properties": { +"additionalParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Additional parameters to be passed to the token endpoint.", +"type": "object" +}, +"clientAssertionJwtAuth": { +"$ref": "ClientAssertionJwtAuth", +"description": "Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT." +}, +"clientSecretAuth": { +"$ref": "ClientSecretAuth", +"description": "Option 1: Authenticate using a standard `client_id` and `client_secret`." +}, +"customIssuer": { +"$ref": "CustomIssuer", +"description": "Configuration when using a custom or third-party authorization server as the issuer." +}, +"googleAccount": { +"$ref": "GoogleAccount", +"description": "Configuration when using Google Accounts as the issuer." +}, +"idJagInput": { +"$ref": "DirectIdJagInput", +"description": "Configuration for when the input is already an ID-JAG." +}, +"idTokenInput": { +"$ref": "IdTokenProcessingConfig", +"description": "Configuration for when the input is an ID token." +}, +"workforceIdentityFederation": { +"$ref": "WorkforceIdentityFederation", +"description": "Configuration when using Workforce Identity Federation as the issuer." +} +}, +"type": "object" +}, +"CustomIssuer": { +"description": "Configuration for a custom or third-party authorization server issuer.", +"id": "CustomIssuer", +"properties": { +"issuer": { +"description": "Optional. The issuer identifier of the target Authorization Server.", +"type": "string" +}, +"tokenUrl": { +"description": "Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens.", +"type": "string" +} +}, +"type": "object" +}, +"DirectIdJagInput": { +"description": "Marker message indicating the input is already an ID-JAG, so no fetching is required.", +"id": "DirectIdJagInput", +"properties": {}, +"type": "object" +}, "DisableAuthProviderRequest": { "description": "Request message for `DisableAuthProvider`.", "id": "DisableAuthProviderRequest", @@ -1304,6 +1461,35 @@ "properties": {}, "type": "object" }, +"GoogleAccount": { +"description": "Configuration for Google Account usage as the issuer.", +"id": "GoogleAccount", +"properties": {}, +"type": "object" +}, +"IdTokenProcessingConfig": { +"description": "Defines how to process an input ID token to obtain an ID-JAG.", +"id": "IdTokenProcessingConfig", +"properties": { +"agentIdentityPool": { +"$ref": "AgentIdentityPool", +"description": "Indicates the managed Agent Identity pool should be used to fetch the ID-JAG." +}, +"idJagAdditionalClaims": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Optional additional claims to include when fetching an ID-JAG.", +"type": "object" +}, +"idJagAuthProvider": { +"description": "The resource name of the ID-JAG auth provider. Format: \"projects/{project}/locations/{location}/authProviders/{auth_provider}\"", +"type": "string" +} +}, +"type": "object" +}, "ListAccessSummariesResponse": { "description": "Response message for `ListAccessSummaries`.", "id": "ListAccessSummariesResponse", @@ -1498,6 +1684,28 @@ }, "type": "object" }, +"ResolveAuthorizationRequest": { +"description": "Request message for `ResolveAuthorization`.", +"id": "ResolveAuthorizationRequest", +"properties": { +"clientUserId": { +"description": "Required. The user ID of the client for whom the authorization is resolved.", +"type": "string" +} +}, +"type": "object" +}, +"ResolveAuthorizationResponse": { +"description": "Response message for `ResolveAuthorization`.", +"id": "ResolveAuthorizationResponse", +"properties": { +"authorization": { +"description": "The resource name of the resolved authorization. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}", +"type": "string" +} +}, +"type": "object" +}, "RevokeAuthorizationRequest": { "description": "Request message for `RevokeAuthorization`.", "id": "RevokeAuthorizationRequest", @@ -1624,6 +1832,12 @@ } }, "type": "object" +}, +"WorkforceIdentityFederation": { +"description": "Configuration for Workforce Identity Federation usage as the issuer.", +"id": "WorkforceIdentityFederation", +"properties": {}, +"type": "object" } }, "servicePath": "", diff --git a/googleapiclient/discovery_cache/documents/agentidentity.v1beta.json b/googleapiclient/discovery_cache/documents/agentidentity.v1beta.json index ec2fc8745c..b02aabbc74 100644 --- a/googleapiclient/discovery_cache/documents/agentidentity.v1beta.json +++ b/googleapiclient/discovery_cache/documents/agentidentity.v1beta.json @@ -607,6 +607,34 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"resolveAuthorization": { +"description": "Resolves an authorization for a user on an auth provider, creating one if it does not exist or returning an existing one.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:resolveAuthorization", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.resolveAuthorization", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The name of the auth provider to resolve authorization for. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+name}:resolveAuthorization", +"request": { +"$ref": "ResolveAuthorizationRequest" +}, +"response": { +"$ref": "ResolveAuthorizationResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "revokeAuthorization": { "description": "Revokes all authorizations for a specific user on an auth provider. This deletes all authorization records associated with the user and auth provider, effectively revoking access across all agents.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}:revokeAuthorization", @@ -778,6 +806,37 @@ "https://www.googleapis.com/auth/cloud-platform" ] }, +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}:getIamPolicy", +"httpMethod": "GET", +"id": "agentidentity.projects.locations.authProviders.authorizations.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:getIamPolicy", +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, "list": { "description": "Lists authorizations in a given project and location.", "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations", @@ -823,6 +882,62 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}:setIamPolicy", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.authorizations.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:setIamPolicy", +"request": { +"$ref": "SetIamPolicyRequest" +}, +"response": { +"$ref": "Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/authProviders/{authProvidersId}/authorizations/{authorizationsId}:testIamPermissions", +"httpMethod": "POST", +"id": "agentidentity.projects.locations.authProviders.authorizations.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/authProviders/[^/]+/authorizations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta/{+resource}:testIamPermissions", +"request": { +"$ref": "TestIamPermissionsRequest" +}, +"response": { +"$ref": "TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] } } } @@ -833,7 +948,7 @@ } } }, -"revision": "20260823", +"revision": "20261001", "rootUrl": "https://agentidentity.googleapis.com/", "schemas": { "AccessSummary": { @@ -852,14 +967,18 @@ "AUTH_PROVIDER_TYPE_THREE_LEGGED_OAUTH", "AUTH_PROVIDER_TYPE_TWO_LEGGED_OAUTH", "AUTH_PROVIDER_TYPE_API_KEY", -"AUTH_PROVIDER_TYPE_GEMINI_ENTERPRISE" +"AUTH_PROVIDER_TYPE_GEMINI_ENTERPRISE", +"AUTH_PROVIDER_TYPE_CROSS_APP_ACCESS", +"AUTH_PROVIDER_TYPE_CONNECTOR_REFERENCE" ], "enumDescriptions": [ "Unspecified auth provider type.", "3-legged OAuth (3LO) auth provider type.", "2-legged OAuth (2LO) auth provider type.", "API key auth provider type.", -"Gemini Enterprise auth provider type." +"Gemini Enterprise auth provider type.", +"Cross-App Access auth provider type.", +"Connector Reference auth provider type." ], "readOnly": true, "type": "string" @@ -920,6 +1039,12 @@ }, "type": "object" }, +"AgentIdentityPool": { +"description": "Marker message to indicate the managed Agent Identity Pool is used.", +"id": "AgentIdentityPool", +"properties": {}, +"type": "object" +}, "ApiKeyParams": { "description": "Configuration for API key authentication.", "id": "ApiKeyParams", @@ -1072,6 +1197,10 @@ "$ref": "ApiKeyParams", "description": "Parameters for API key authentication." }, +"connectorReferenceAuthProvider": { +"$ref": "ConnectorReferenceAuthProvider", +"description": "Parameters for Connector Reference authentication." +}, "geAuthProvider": { "$ref": "GeminiEnterpriseAuthProviderParams", "description": "Parameters for Gemini Enterprise authentication." @@ -1083,6 +1212,10 @@ "twoLeggedOauth": { "$ref": "TwoLeggedOAuth", "description": "Parameters for 2-legged OAuth (2LO) authentication." +}, +"xaaAuthProvider": { +"$ref": "CrossAppAccessAuthProvider", +"description": "Parameters for Cross-App Access authentication." } }, "type": "object" @@ -1160,6 +1293,117 @@ }, "type": "object" }, +"ClientAssertionJwtAuth": { +"description": "Configuration for client ID and client assertion JWT authentication.", +"id": "ClientAssertionJwtAuth", +"properties": { +"clientId": { +"description": "Required. The client identifier.", +"type": "string" +} +}, +"type": "object" +}, +"ClientSecretAuth": { +"description": "Configuration for client ID and client secret authentication.", +"id": "ClientSecretAuth", +"properties": { +"clientId": { +"description": "Required. The client identifier.", +"type": "string" +}, +"clientSecret": { +"description": "Required. Input only. The client secret.", +"type": "string" +} +}, +"type": "object" +}, +"ConnectorReferenceAuthProvider": { +"description": "Configuration parameters for the Connector Reference auth provider.", +"id": "ConnectorReferenceAuthProvider", +"properties": { +"authorizationDetails": { +"description": "Optional. Rich Authorization Requests (RFC 9396) detailing targeted OAuth resources/scopes, formatted as a JSON array of JSON objects.", +"items": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +}, +"connector": { +"description": "Required. The name of the referenced connector.", +"type": "string" +} +}, +"type": "object" +}, +"CrossAppAccessAuthProvider": { +"description": "Configuration parameters for the Cross-App Access auth provider.", +"id": "CrossAppAccessAuthProvider", +"properties": { +"additionalParameters": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Additional parameters to be passed to the token endpoint.", +"type": "object" +}, +"clientAssertionJwtAuth": { +"$ref": "ClientAssertionJwtAuth", +"description": "Option 2: Authenticate using a standard `client_id` and a Client Assertion JWT." +}, +"clientSecretAuth": { +"$ref": "ClientSecretAuth", +"description": "Option 1: Authenticate using a standard `client_id` and `client_secret`." +}, +"customIssuer": { +"$ref": "CustomIssuer", +"description": "Configuration when using a custom or third-party authorization server as the issuer." +}, +"googleAccount": { +"$ref": "GoogleAccount", +"description": "Configuration when using Google Accounts as the issuer." +}, +"idJagInput": { +"$ref": "DirectIdJagInput", +"description": "Configuration for when the input is already an ID-JAG." +}, +"idTokenInput": { +"$ref": "IdTokenProcessingConfig", +"description": "Configuration for when the input is an ID token." +}, +"workforceIdentityFederation": { +"$ref": "WorkforceIdentityFederation", +"description": "Configuration when using Workforce Identity Federation as the issuer." +} +}, +"type": "object" +}, +"CustomIssuer": { +"description": "Configuration for a custom or third-party authorization server issuer.", +"id": "CustomIssuer", +"properties": { +"issuer": { +"description": "Optional. The issuer identifier of the target Authorization Server.", +"type": "string" +}, +"tokenUrl": { +"description": "Required. The token endpoint of the target OAuth authorization server to retrieve resource tokens.", +"type": "string" +} +}, +"type": "object" +}, +"DirectIdJagInput": { +"description": "Marker message indicating the input is already an ID-JAG, so no fetching is required.", +"id": "DirectIdJagInput", +"properties": {}, +"type": "object" +}, "DisableAuthProviderRequest": { "description": "Request message for `DisableAuthProvider`.", "id": "DisableAuthProviderRequest", @@ -1217,6 +1461,35 @@ "properties": {}, "type": "object" }, +"GoogleAccount": { +"description": "Configuration for Google Account usage as the issuer.", +"id": "GoogleAccount", +"properties": {}, +"type": "object" +}, +"IdTokenProcessingConfig": { +"description": "Defines how to process an input ID token to obtain an ID-JAG.", +"id": "IdTokenProcessingConfig", +"properties": { +"agentIdentityPool": { +"$ref": "AgentIdentityPool", +"description": "Indicates the managed Agent Identity pool should be used to fetch the ID-JAG." +}, +"idJagAdditionalClaims": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Optional additional claims to include when fetching an ID-JAG.", +"type": "object" +}, +"idJagAuthProvider": { +"description": "The resource name of the ID-JAG auth provider. Format: \"projects/{project}/locations/{location}/authProviders/{auth_provider}\"", +"type": "string" +} +}, +"type": "object" +}, "ListAccessSummariesResponse": { "description": "Response message for `ListAccessSummaries`.", "id": "ListAccessSummariesResponse", @@ -1411,6 +1684,28 @@ }, "type": "object" }, +"ResolveAuthorizationRequest": { +"description": "Request message for `ResolveAuthorization`.", +"id": "ResolveAuthorizationRequest", +"properties": { +"clientUserId": { +"description": "Required. The user ID of the client for whom the authorization is resolved.", +"type": "string" +} +}, +"type": "object" +}, +"ResolveAuthorizationResponse": { +"description": "Response message for `ResolveAuthorization`.", +"id": "ResolveAuthorizationResponse", +"properties": { +"authorization": { +"description": "The resource name of the resolved authorization. Format: projects/{project}/locations/{location}/authProviders/{auth_provider}/authorizations/{authorization}", +"type": "string" +} +}, +"type": "object" +}, "RevokeAuthorizationRequest": { "description": "Request message for `RevokeAuthorization`.", "id": "RevokeAuthorizationRequest", @@ -1537,6 +1832,12 @@ } }, "type": "object" +}, +"WorkforceIdentityFederation": { +"description": "Configuration for Workforce Identity Federation usage as the issuer.", +"id": "WorkforceIdentityFederation", +"properties": {}, +"type": "object" } }, "servicePath": "", From 6a4d5b656c16664431a564e3cd8eb73becd35c37 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:35 +0000 Subject: [PATCH 04/41] feat(aiplatform): update the api #### aiplatform:v1 The following keys were deleted: - schemas.CloudAiLargeModelsVisionExperimentsResponseProEditResult.properties.structuredPrompt.additionalProperties.type (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsProEditConfig.properties.structuredPrompt.additionalProperties.type (Total Keys: 1) The following keys were added: - resources.projects.methods.updateCacheConfig.parameters.updateMask (Total Keys: 3) - schemas.GoogleCloudAiplatformV1CacheConfig.properties.retentionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1CacheConfigRetentionConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1GenerateMemoriesRequest.properties.timeZone.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1Part.properties.speechMetadata.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1SemanticGovernancePolicy.properties.dryRun.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1SpeechMetadata (Total Keys: 4) - schemas.GoogleCloudAiplatformV1ToolComputerUse.properties.disabledSafetyPolicies (Total Keys: 2) - schemas.GoogleCloudAiplatformV1TuningJob.properties.gcsMetricsUri (Total Keys: 2) - schemas.GoogleCloudAiplatformV1VoiceConfig.properties.voice.type (Total Keys: 1) The following keys were changed: - endpoints (Total Keys: 1) - resources.projects.resources.locations.resources.agents.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.agents.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.agents.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.agents.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.agents.methods.patch.scopes (Total Keys: 1) - schemas.CloudAiLargeModelsVisionExperimentsResponseProEditResult.properties.structuredPrompt.type (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsProEditConfig.properties.structuredPrompt.type (Total Keys: 1) #### aiplatform:v1beta1 The following keys were deleted: - schemas.CloudAiLargeModelsVisionExperimentsResponseProEditResult.properties.structuredPrompt.additionalProperties.type (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsProEditConfig.properties.structuredPrompt.additionalProperties.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1A2ATaskRecord.properties.status.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1A2ATaskRecordStatus.properties.message.readOnly (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1A2ATaskRecordStatus.properties.state.readOnly (Total Keys: 1) The following keys were added: - resources.projects.methods.updateCacheConfig.parameters.updateMask (Total Keys: 3) - resources.projects.resources.locations.resources.voices.methods.create (Total Keys: 12) - resources.projects.resources.locations.resources.voices.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.voices.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.voices.methods.list (Total Keys: 42) - schemas.GenaiVertexV1beta1AudioData (Total Keys: 5) - schemas.GenaiVertexV1beta1SpeechAnnotation (Total Keys: 4) - schemas.GenaiVertexV1beta1TextContentAnnotation.properties.speechMetadata.$ref (Total Keys: 1) - schemas.GenaiVertexV1beta1Voice (Total Keys: 32) - schemas.GoogleCloudAiplatformV1beta1CacheConfig.properties.retentionConfig.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1CacheConfigRetentionConfig (Total Keys: 3) - schemas.GoogleCloudAiplatformV1beta1GenerateMemoriesRequest.properties.timeZone.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1Part.properties.speechMetadata.$ref (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec.properties.outpaintingMode.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1SandboxEnvironmentTemplatePersistentDiskConfig.properties.mountPath.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1SemanticGovernancePolicy.properties.dryRun.type (Total Keys: 1) - schemas.GoogleCloudAiplatformV1beta1SpeechMetadata (Total Keys: 4) - schemas.GoogleCloudAiplatformV1beta1ToolComputerUse.properties.disabledSafetyPolicies (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1TuningJob.properties.gcsMetricsUri (Total Keys: 2) - schemas.GoogleCloudAiplatformV1beta1VoiceConfig.properties.voice.type (Total Keys: 1) - schemas.GoogleLearningVertexApiInteractionsV1beta1CreateVoiceHttpTranscoderRequest (Total Keys: 3) - schemas.GoogleLearningVertexApiInteractionsV1beta1CreateVoiceRequest (Total Keys: 4) - schemas.GoogleLearningVertexApiInteractionsV1beta1DeleteVoiceResponse (Total Keys: 2) - schemas.GoogleLearningVertexApiInteractionsV1beta1ListVoicesResponse (Total Keys: 5) The following keys were changed: - endpoints (Total Keys: 1) - resources.projects.resources.locations.resources.agents.methods.create.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.agents.methods.delete.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.agents.methods.get.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.agents.methods.list.scopes (Total Keys: 1) - resources.projects.resources.locations.resources.agents.methods.patch.scopes (Total Keys: 1) - schemas.CloudAiLargeModelsVisionExperimentsResponseProEditResult.properties.structuredPrompt.type (Total Keys: 1) - schemas.CloudAiLargeModelsVisionGenerateVideoExperimentsProEditConfig.properties.structuredPrompt.type (Total Keys: 1) --- docs/dyn/aiplatform_v1.endpoints.html | 51 ++ docs/dyn/aiplatform_v1.projects.html | 11 +- ...platform_v1.projects.locations.agents.html | 16 +- ..._v1.projects.locations.cachedContents.html | 66 +++ ...tform_v1.projects.locations.endpoints.html | 51 ++ ...v1.projects.locations.evaluationItems.html | 272 +++++++++ ....projects.locations.evaluationMetrics.html | 16 + ..._v1.projects.locations.evaluationRuns.html | 92 +++ ..._v1.projects.locations.evaluationSets.html | 21 + .../dyn/aiplatform_v1.projects.locations.html | 148 +++++ ...orm_v1.projects.locations.memoryBanks.html | 4 + ...ojects.locations.memoryBanks.memories.html | 5 + ...1.projects.locations.onlineEvaluators.html | 16 + ....projects.locations.publishers.models.html | 55 ++ ...1.projects.locations.reasoningEngines.html | 16 + ...s.locations.reasoningEngines.memories.html | 9 + ...ions.reasoningEngines.sessions.events.html | 4 + ...s.locations.reasoningEngines.sessions.html | 4 + ....locations.semanticGovernancePolicies.html | 4 + ...form_v1.projects.locations.tuningJobs.html | 105 ++++ docs/dyn/aiplatform_v1.publishers.models.html | 51 ++ docs/dyn/aiplatform_v1.reasoningEngines.html | 16 + docs/dyn/aiplatform_v1.v1.html | 85 +++ docs/dyn/aiplatform_v1beta1.endpoints.html | 51 ++ docs/dyn/aiplatform_v1beta1.interactions.html | 384 ++++++++++++ docs/dyn/aiplatform_v1beta1.memoryBanks.html | 4 + ...platform_v1beta1.memoryBanks.memories.html | 5 + docs/dyn/aiplatform_v1beta1.projects.html | 11 +- ...orm_v1beta1.projects.locations.agents.html | 16 +- ...ta1.projects.locations.cachedContents.html | 66 +++ ...m_v1beta1.projects.locations.datasets.html | 26 + ..._v1beta1.projects.locations.endpoints.html | 51 ++ ...a1.projects.locations.evaluationItems.html | 336 +++++++++++ ....projects.locations.evaluationMetrics.html | 16 + ...ta1.projects.locations.evaluationRuns.html | 288 +++++++++ ...ta1.projects.locations.evaluationSets.html | 21 + ...eta1.projects.locations.exampleStores.html | 36 ++ ...v1beta1.projects.locations.extensions.html | 8 + ...aiplatform_v1beta1.projects.locations.html | 171 ++++++ ...beta1.projects.locations.interactions.html | 468 +++++++++++++++ ...1beta1.projects.locations.memoryBanks.html | 4 + ...ojects.locations.memoryBanks.memories.html | 5 + ...1.projects.locations.onlineEvaluators.html | 16 + ....projects.locations.publishers.models.html | 55 ++ ...ions.reasoningEngines.a2aTasks.events.html | 12 + ...s.locations.reasoningEngines.a2aTasks.html | 44 ++ ...ions.reasoningEngines.feedbackEntries.html | 8 + ...1.projects.locations.reasoningEngines.html | 16 + ...s.locations.reasoningEngines.memories.html | 9 + ...ngEngines.sandboxEnvironmentTemplates.html | 3 + ...ions.reasoningEngines.sessions.events.html | 4 + ...s.locations.reasoningEngines.sessions.html | 4 + ....locations.semanticGovernancePolicies.html | 4 + ...s.locations.taskStores.a2aTaskRecords.html | 42 +- ...v1beta1.projects.locations.tuningJobs.html | 303 ++++++++++ ...orm_v1beta1.projects.locations.voices.html | 488 +++++++++++++++ .../aiplatform_v1beta1.publishers.models.html | 51 ++ .../aiplatform_v1beta1.reasoningEngines.html | 16 + ...orm_v1beta1.reasoningEngines.memories.html | 9 + ...ngEngines.sandboxEnvironmentTemplates.html | 3 + ...eta1.reasoningEngines.sessions.events.html | 4 + ...orm_v1beta1.reasoningEngines.sessions.html | 4 + docs/dyn/aiplatform_v1beta1.v1beta1.html | 95 +++ .../documents/aiplatform.v1.json | 126 +++- .../documents/aiplatform.v1beta1.json | 554 +++++++++++++++++- 65 files changed, 4874 insertions(+), 81 deletions(-) create mode 100644 docs/dyn/aiplatform_v1beta1.projects.locations.voices.html diff --git a/docs/dyn/aiplatform_v1.endpoints.html b/docs/dyn/aiplatform_v1.endpoints.html index f06f6bf371..31ff268ca6 100644 --- a/docs/dyn/aiplatform_v1.endpoints.html +++ b/docs/dyn/aiplatform_v1.endpoints.html @@ -202,6 +202,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -332,6 +336,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -480,6 +488,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -492,6 +501,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -591,6 +601,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -608,6 +622,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -988,6 +1005,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1136,6 +1157,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1148,6 +1170,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1257,6 +1280,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1290,6 +1317,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1624,6 +1654,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2004,6 +2038,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2152,6 +2190,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2164,6 +2203,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2273,6 +2313,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2306,6 +2350,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2640,6 +2687,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.projects.html b/docs/dyn/aiplatform_v1.projects.html index 4de13a841d..4f2b00862b 100644 --- a/docs/dyn/aiplatform_v1.projects.html +++ b/docs/dyn/aiplatform_v1.projects.html @@ -86,7 +86,7 @@

Instance Methods

getCacheConfig(name, x__xgafv=None)

Gets a GenAI cache config.

- updateCacheConfig(name, body=None, x__xgafv=None)

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

Updates a cache config.

Method Details

@@ -111,11 +111,14 @@

Method Details

{ # Config of GenAI caching features. This is a singleton resource. "disableCache": True or False, # If set to true, disables GenAI caching. Otherwise caching is enabled. "name": "A String", # Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`. + "retentionConfig": { # Configures the retention behavior of GenAI implicit (automatic) context caching for this project. # Optional. Project-level retention type for implicit caching. On `GetCacheConfig` this is populated with the retention the project gets: a project that has stated no preference reports `DURABLE`. On `UpdateCacheConfig`, leaving it unset means the project states no preference. Whether that clears an existing preference depends on `update_mask`; see that field. + "retentionType": "A String", # Optional. Retention type applied to implicit cache traffic for this project. + }, }
- updateCacheConfig(name, body=None, x__xgafv=None) + updateCacheConfig(name, body=None, updateMask=None, x__xgafv=None)
Updates a cache config.
 
 Args:
@@ -126,8 +129,12 @@ 

Method Details

{ # Config of GenAI caching features. This is a singleton resource. "disableCache": True or False, # If set to true, disables GenAI caching. Otherwise caching is enabled. "name": "A String", # Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`. + "retentionConfig": { # Configures the retention behavior of GenAI implicit (automatic) context caching for this project. # Optional. Project-level retention type for implicit caching. On `GetCacheConfig` this is populated with the retention the project gets: a project that has stated no preference reports `DURABLE`. On `UpdateCacheConfig`, leaving it unset means the project states no preference. Whether that clears an existing preference depends on `update_mask`; see that field. + "retentionType": "A String", # Optional. Retention type applied to implicit cache traffic for this project. + }, } + updateMask: string, Optional. The list of fields of `cache_config` to update. Supported paths are `disable_cache`, `retention_config` (and its subfields such as `retention_config.retention_type`), and the special value `*`; any other path returns `INVALID_ARGUMENT`. Fields not covered by the mask keep their stored value. If the mask is omitted, it is treated as an implied mask covering the fields populated in `cache_config`, so updating one field never clears another. `retention_config` is covered only when the request carries it. `disable_cache` is always covered: it is a bare `bool`, so the server cannot tell a request that omits it from one that sets it to `false`. `*` requests full replacement of the resource: every settable field is written from the request, clearing `retention_config` when the request omits it. It cannot be combined with other paths. Prefer naming fields explicitly -- a caller that sends `*` without knowing about a field added to `CacheConfig` later would silently reset that field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1.projects.locations.agents.html b/docs/dyn/aiplatform_v1.projects.locations.agents.html index d4e643c892..7552ad1069 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.agents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.agents.html @@ -136,13 +136,13 @@

Method Details

}, "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. "tools": [ # Optional. The tools available to the agent. - { # A tool provides a list of actions available to the Agent during the process of executing a task. + { # A tool provides a list of actions available to the Agent during the process of executing a task. Example JSON for an MCP server tool: { "type": "mcp_server", "name": "my-mcp-server", "url": "https://api.example.com/mcp", "headers": { "Authorization": "Bearer token123" } } "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, "name": "A String", # Optional. The tool's Google Cloud resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. + "url": "A String", # Optional. Fallback for the tool's runtime reference, consumed by `CreateAgent` to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`, and optional: the Agent service derives the runtime reference from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), and reads this only when that lookup yields none. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -244,13 +244,13 @@

Method Details

}, "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. "tools": [ # Optional. The tools available to the agent. - { # A tool provides a list of actions available to the Agent during the process of executing a task. + { # A tool provides a list of actions available to the Agent during the process of executing a task. Example JSON for an MCP server tool: { "type": "mcp_server", "name": "my-mcp-server", "url": "https://api.example.com/mcp", "headers": { "Authorization": "Bearer token123" } } "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, "name": "A String", # Optional. The tool's Google Cloud resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. + "url": "A String", # Optional. Fallback for the tool's runtime reference, consumed by `CreateAgent` to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`, and optional: the Agent service derives the runtime reference from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), and reads this only when that lookup yields none. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -329,13 +329,13 @@

Method Details

}, "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. "tools": [ # Optional. The tools available to the agent. - { # A tool provides a list of actions available to the Agent during the process of executing a task. + { # A tool provides a list of actions available to the Agent during the process of executing a task. Example JSON for an MCP server tool: { "type": "mcp_server", "name": "my-mcp-server", "url": "https://api.example.com/mcp", "headers": { "Authorization": "Bearer token123" } } "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, "name": "A String", # Optional. The tool's Google Cloud resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. + "url": "A String", # Optional. Fallback for the tool's runtime reference, consumed by `CreateAgent` to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`, and optional: the Agent service derives the runtime reference from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), and reads this only when that lookup yields none. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -385,13 +385,13 @@

Method Details

}, "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. "tools": [ # Optional. The tools available to the agent. - { # A tool provides a list of actions available to the Agent during the process of executing a task. + { # A tool provides a list of actions available to the Agent during the process of executing a task. Example JSON for an MCP server tool: { "type": "mcp_server", "name": "my-mcp-server", "url": "https://api.example.com/mcp", "headers": { "Authorization": "Bearer token123" } } "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, "name": "A String", # Optional. The tool's Google Cloud resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. + "url": "A String", # Optional. Fallback for the tool's runtime reference, consumed by `CreateAgent` to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`, and optional: the Agent service derives the runtime reference from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), and reads this only when that lookup yields none. }, ], "updated": "A String", # Output only. The time the agent was last updated. diff --git a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html index fb9e11e9dd..505564a4fe 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1.projects.locations.cachedContents.html @@ -189,6 +189,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -287,6 +291,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -320,6 +328,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -645,6 +656,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -743,6 +758,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -776,6 +795,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1126,6 +1148,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1224,6 +1250,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1257,6 +1287,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1593,6 +1626,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1691,6 +1728,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1724,6 +1765,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2068,6 +2112,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2166,6 +2214,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2199,6 +2251,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2525,6 +2580,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2623,6 +2682,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2656,6 +2719,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. diff --git a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html index f2c42cedbb..5f30291d96 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1.projects.locations.endpoints.html @@ -275,6 +275,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -405,6 +409,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -553,6 +561,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -565,6 +574,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -664,6 +674,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -681,6 +695,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1957,6 +1974,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2105,6 +2126,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2117,6 +2139,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2226,6 +2249,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2259,6 +2286,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2593,6 +2623,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4455,6 +4489,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4603,6 +4641,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4615,6 +4654,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4724,6 +4764,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4757,6 +4801,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -5091,6 +5138,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html index 769b646b52..be9727f283 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationItems.html @@ -138,6 +138,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -376,6 +379,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -681,6 +687,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -734,6 +744,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -972,6 +985,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1277,6 +1293,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1329,6 +1349,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1567,6 +1590,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1872,6 +1898,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1974,6 +2004,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2071,6 +2105,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2309,6 +2346,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2614,6 +2654,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2667,6 +2711,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2905,6 +2952,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3210,6 +3260,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3262,6 +3316,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3500,6 +3557,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3805,6 +3865,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3907,6 +3971,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3995,6 +4063,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4233,6 +4304,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4538,6 +4612,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4591,6 +4669,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4829,6 +4910,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -5134,6 +5218,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5186,6 +5274,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -5424,6 +5515,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -5729,6 +5823,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5831,6 +5929,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5928,6 +6030,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -6166,6 +6271,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -6471,6 +6579,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6524,6 +6636,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -6762,6 +6877,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7067,6 +7185,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7119,6 +7241,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7357,6 +7482,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7662,6 +7790,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7764,6 +7896,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7894,6 +8030,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8132,6 +8271,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8437,6 +8579,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8490,6 +8636,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8728,6 +8877,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9033,6 +9185,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -9085,6 +9241,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9323,6 +9482,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9628,6 +9790,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -9730,6 +9896,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -9827,6 +9997,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -10065,6 +10238,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -10370,6 +10546,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -10423,6 +10603,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -10661,6 +10844,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -10966,6 +11152,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11018,6 +11208,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -11256,6 +11449,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -11561,6 +11757,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11663,6 +11863,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11764,6 +11968,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -12002,6 +12209,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -12307,6 +12517,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12360,6 +12574,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -12598,6 +12815,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -12903,6 +13123,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12955,6 +13179,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -13193,6 +13420,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -13498,6 +13728,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -13600,6 +13834,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -13697,6 +13935,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -13935,6 +14176,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -14240,6 +14484,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -14293,6 +14541,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -14531,6 +14782,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -14836,6 +15090,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -14888,6 +15146,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -15126,6 +15387,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -15431,6 +15695,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -15533,6 +15801,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html index da75424db8..252ac49444 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationMetrics.html @@ -278,6 +278,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -290,6 +291,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -461,6 +463,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -473,6 +476,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -726,6 +730,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -738,6 +743,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -909,6 +915,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -921,6 +928,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1215,6 +1223,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1227,6 +1236,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1398,6 +1408,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1410,6 +1421,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1675,6 +1687,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1687,6 +1700,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1858,6 +1872,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1870,6 +1885,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html index 09ba4f804e..60681c90e3 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationRuns.html @@ -304,6 +304,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -316,6 +317,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -509,6 +511,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -521,6 +524,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -687,6 +691,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -699,6 +704,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -889,6 +895,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -901,6 +908,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1072,6 +1080,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1084,6 +1093,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1312,6 +1322,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1324,6 +1335,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1484,6 +1496,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1496,6 +1509,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1685,6 +1699,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1697,6 +1712,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1891,6 +1907,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1903,6 +1920,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1938,6 +1956,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2302,6 +2323,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2314,6 +2336,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2526,6 +2549,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2538,6 +2562,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2731,6 +2756,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2743,6 +2769,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2909,6 +2936,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2921,6 +2949,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3111,6 +3140,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3123,6 +3153,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3294,6 +3325,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3306,6 +3338,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3534,6 +3567,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3546,6 +3580,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3706,6 +3741,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3718,6 +3754,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3907,6 +3944,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3919,6 +3957,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4113,6 +4152,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4125,6 +4165,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4160,6 +4201,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4524,6 +4568,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4536,6 +4581,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4790,6 +4836,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4802,6 +4849,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4995,6 +5043,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5007,6 +5056,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5173,6 +5223,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5185,6 +5236,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5375,6 +5427,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5387,6 +5440,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5558,6 +5612,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5570,6 +5625,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5798,6 +5854,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5810,6 +5867,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5970,6 +6028,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5982,6 +6041,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6171,6 +6231,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6183,6 +6244,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6377,6 +6439,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6389,6 +6452,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6424,6 +6488,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -6788,6 +6855,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6800,6 +6868,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -7025,6 +7094,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -7037,6 +7107,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -7230,6 +7301,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -7242,6 +7314,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -7408,6 +7481,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -7420,6 +7494,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -7610,6 +7685,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -7622,6 +7698,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -7793,6 +7870,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -7805,6 +7883,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -8033,6 +8112,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -8045,6 +8125,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -8205,6 +8286,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -8217,6 +8299,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -8406,6 +8489,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -8418,6 +8502,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -8612,6 +8697,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -8624,6 +8710,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -8659,6 +8746,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9023,6 +9113,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -9035,6 +9126,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. diff --git a/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html index a8c04186e9..69cb4acfc5 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html +++ b/docs/dyn/aiplatform_v1.projects.locations.evaluationSets.html @@ -128,6 +128,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -393,6 +396,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -700,6 +706,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -999,6 +1008,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1331,6 +1343,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1615,6 +1630,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1881,6 +1899,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. diff --git a/docs/dyn/aiplatform_v1.projects.locations.html b/docs/dyn/aiplatform_v1.projects.locations.html index be8777968e..15ed854b31 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.html +++ b/docs/dyn/aiplatform_v1.projects.locations.html @@ -399,6 +399,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -694,6 +697,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1040,6 +1046,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1174,6 +1184,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1301,6 +1315,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1742,6 +1760,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1754,6 +1773,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1946,6 +1966,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1958,6 +1979,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2129,6 +2151,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2141,6 +2164,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2395,6 +2419,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2407,6 +2432,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2580,6 +2606,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2605,6 +2635,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2920,6 +2953,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2945,6 +2982,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3256,6 +3296,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3351,6 +3395,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3371,6 +3419,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3609,6 +3660,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3914,6 +3968,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4025,6 +4083,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4123,6 +4185,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4219,6 +4285,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4315,6 +4385,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4513,6 +4587,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4525,6 +4600,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4696,6 +4772,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4708,6 +4785,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4941,6 +5019,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4953,6 +5032,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5124,6 +5204,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5136,6 +5217,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5301,6 +5383,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5438,6 +5524,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6091,6 +6181,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6116,6 +6210,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -6424,6 +6521,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6584,6 +6685,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6596,6 +6698,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6724,6 +6827,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -6962,6 +7068,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7267,6 +7376,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7320,6 +7433,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7558,6 +7674,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7863,6 +7982,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7915,6 +8038,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8153,6 +8279,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8458,6 +8587,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8560,6 +8693,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8726,6 +8863,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8845,6 +8986,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8889,6 +9034,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. diff --git a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html index 005b3509fd..083707b635 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html +++ b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.html @@ -186,6 +186,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.html b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.html index 1538e84b6d..a70ee7686f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.html +++ b/docs/dyn/aiplatform_v1.projects.locations.memoryBanks.memories.html @@ -328,6 +328,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -375,6 +379,7 @@

Method Details

"scope": { # Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "timeZone": "A String", # Optional. The time zone of the conversation or caller, used as the baseline for resolving relative time expressions (e.g., "yesterday") and formatting timestamps. If not set, "UTC" is used. Must be a valid IANA Time Zone Database name, e.g. "America/New_York". "vertexSessionSource": { # Defines an Agent Engine Session from which to generate the memories. If `scope` is not provided, the scope will be extracted from the Session (i.e. {"user_id": sesison.user_id}). # Defines a Vertex Session as the source content from which to generate memories. "endTime": "A String", # Optional. End time (exclusive) of the time range. If not set, the end time is unbounded. "session": "A String", # Required. The resource name of the Session to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` diff --git a/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html b/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html index 353058f5ad..512f39ac9e 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html +++ b/docs/dyn/aiplatform_v1.projects.locations.onlineEvaluators.html @@ -392,6 +392,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -404,6 +405,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -575,6 +577,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -587,6 +590,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -977,6 +981,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -989,6 +994,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1160,6 +1166,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1172,6 +1179,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1506,6 +1514,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1518,6 +1527,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1689,6 +1699,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1701,6 +1712,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2039,6 +2051,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2051,6 +2064,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2222,6 +2236,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2234,6 +2249,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. diff --git a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html index b0be094054..af9ee3c61c 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1.projects.locations.publishers.models.html @@ -209,6 +209,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -339,6 +343,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -487,6 +495,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -499,6 +508,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -598,6 +608,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -615,6 +629,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -952,6 +969,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1159,6 +1180,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1307,6 +1332,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1319,6 +1345,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1428,6 +1455,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1461,6 +1492,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1795,6 +1829,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2403,6 +2441,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2551,6 +2593,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2563,6 +2606,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2672,6 +2716,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2705,6 +2753,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3039,6 +3090,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html index 695b9d568a..932f65c131 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.html @@ -329,6 +329,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -736,6 +740,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1074,6 +1082,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1382,6 +1394,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html index 5494446479..4f13275cc3 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.memories.html @@ -331,6 +331,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -378,6 +382,7 @@

Method Details

"scope": { # Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "timeZone": "A String", # Optional. The time zone of the conversation or caller, used as the baseline for resolving relative time expressions (e.g., "yesterday") and formatting timestamps. If not set, "UTC" is used. Must be a valid IANA Time Zone Database name, e.g. "America/New_York". "vertexSessionSource": { # Defines an Agent Engine Session from which to generate the memories. If `scope` is not provided, the scope will be extracted from the Session (i.e. {"user_id": sesison.user_id}). # Defines a Vertex Session as the source content from which to generate memories. "endTime": "A String", # Optional. End time (exclusive) of the time range. If not set, the end time is unbounded. "session": "A String", # Required. The resource name of the Session to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` @@ -554,6 +559,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html index 07c1fced1d..9837adadd9 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.events.html @@ -203,6 +203,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html index 9aab542a07..07a19e42d2 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1.projects.locations.reasoningEngines.sessions.html @@ -214,6 +214,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicies.html b/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicies.html index 603100acbd..a579b76b3f 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicies.html +++ b/docs/dyn/aiplatform_v1.projects.locations.semanticGovernancePolicies.html @@ -124,6 +124,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. + "dryRun": True or False, # Optional. If true, this policy is evaluated and its result is reported, but the policy is not enforced: a violation does not block the agent's action. Use this to validate a policy against real traffic before turning enforcement on. Defaults to `false`, meaning the policy is enforced. This setting applies only to this policy. If the SemanticGovernancePolicyEngine for the project is itself in dry run, every policy behaves as dry run regardless of this field. "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned. "mcpTools": [ # Optional. The McpTools that are affected by this policy. { # Represents a governance policy applied to MCP tools used by an Agent. @@ -227,6 +228,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. + "dryRun": True or False, # Optional. If true, this policy is evaluated and its result is reported, but the policy is not enforced: a violation does not block the agent's action. Use this to validate a policy against real traffic before turning enforcement on. Defaults to `false`, meaning the policy is enforced. This setting applies only to this policy. If the SemanticGovernancePolicyEngine for the project is itself in dry run, every policy behaves as dry run regardless of this field. "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned. "mcpTools": [ # Optional. The McpTools that are affected by this policy. { # Represents a governance policy applied to MCP tools used by an Agent. @@ -270,6 +272,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. + "dryRun": True or False, # Optional. If true, this policy is evaluated and its result is reported, but the policy is not enforced: a violation does not block the agent's action. Use this to validate a policy against real traffic before turning enforcement on. Defaults to `false`, meaning the policy is enforced. This setting applies only to this policy. If the SemanticGovernancePolicyEngine for the project is itself in dry run, every policy behaves as dry run regardless of this field. "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned. "mcpTools": [ # Optional. The McpTools that are affected by this policy. { # Represents a governance policy applied to MCP tools used by an Agent. @@ -319,6 +322,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. + "dryRun": True or False, # Optional. If true, this policy is evaluated and its result is reported, but the policy is not enforced: a violation does not block the agent's action. Use this to validate a policy against real traffic before turning enforcement on. Defaults to `false`, meaning the policy is enforced. This setting applies only to this policy. If the SemanticGovernancePolicyEngine for the project is itself in dry run, every policy behaves as dry run regardless of this field. "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned. "mcpTools": [ # Optional. The McpTools that are affected by this policy. { # Represents a governance policy applied to MCP tools used by an Agent. diff --git a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html index 7c905633a1..669687e261 100644 --- a/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1.projects.locations.tuningJobs.html @@ -229,6 +229,7 @@

Method Details

}, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "gcsMetricsUri": "A String", # Output only. The Cloud Storage metrics URI associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", }, @@ -392,6 +393,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -404,6 +406,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -565,6 +568,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -577,6 +581,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -756,6 +761,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -768,6 +774,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -939,6 +946,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -951,6 +959,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1173,6 +1182,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1266,6 +1279,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1405,6 +1422,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1572,6 +1593,7 @@

Method Details

}, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "gcsMetricsUri": "A String", # Output only. The Cloud Storage metrics URI associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", }, @@ -1735,6 +1757,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1747,6 +1770,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1908,6 +1932,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1920,6 +1945,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2099,6 +2125,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2111,6 +2138,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2282,6 +2310,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2294,6 +2323,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2516,6 +2546,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2609,6 +2643,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2748,6 +2786,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2922,6 +2964,7 @@

Method Details

}, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "gcsMetricsUri": "A String", # Output only. The Cloud Storage metrics URI associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", }, @@ -3085,6 +3128,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3097,6 +3141,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3258,6 +3303,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3270,6 +3316,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3449,6 +3496,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3461,6 +3509,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3632,6 +3681,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3644,6 +3694,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3866,6 +3917,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3959,6 +4014,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4098,6 +4157,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4278,6 +4341,7 @@

Method Details

}, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "gcsMetricsUri": "A String", # Output only. The Cloud Storage metrics URI associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", }, @@ -4441,6 +4505,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4453,6 +4518,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4614,6 +4680,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4626,6 +4693,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4805,6 +4873,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4817,6 +4886,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4988,6 +5058,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5000,6 +5071,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5222,6 +5294,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5315,6 +5391,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5454,6 +5534,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5649,6 +5733,7 @@

Method Details

}, ], "experiment": "A String", # Output only. The Experiment associated with this TuningJob. + "gcsMetricsUri": "A String", # Output only. The Cloud Storage metrics URI associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", }, @@ -5812,6 +5897,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5824,6 +5910,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5985,6 +6072,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5997,6 +6085,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6176,6 +6265,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6188,6 +6278,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6359,6 +6450,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6371,6 +6463,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6593,6 +6686,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6686,6 +6783,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6825,6 +6926,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.publishers.models.html b/docs/dyn/aiplatform_v1.publishers.models.html index 3f45af8ec1..df3743f314 100644 --- a/docs/dyn/aiplatform_v1.publishers.models.html +++ b/docs/dyn/aiplatform_v1.publishers.models.html @@ -195,6 +195,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -325,6 +329,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -473,6 +481,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -485,6 +494,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -584,6 +594,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -601,6 +615,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -981,6 +998,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1129,6 +1150,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1141,6 +1163,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1250,6 +1273,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1283,6 +1310,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1617,6 +1647,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2572,6 +2606,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2720,6 +2758,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2732,6 +2771,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2841,6 +2881,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2874,6 +2918,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3208,6 +3255,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.reasoningEngines.html b/docs/dyn/aiplatform_v1.reasoningEngines.html index 4ad8c9c9d5..c606219dc3 100644 --- a/docs/dyn/aiplatform_v1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1.reasoningEngines.html @@ -319,6 +319,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -727,6 +731,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1030,6 +1038,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1338,6 +1350,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1.v1.html b/docs/dyn/aiplatform_v1.v1.html index 79818753f5..54a2338226 100644 --- a/docs/dyn/aiplatform_v1.v1.html +++ b/docs/dyn/aiplatform_v1.v1.html @@ -239,6 +239,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -251,6 +252,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -443,6 +445,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -455,6 +458,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -626,6 +630,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -638,6 +643,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -891,6 +897,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -903,6 +910,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1076,6 +1084,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1101,6 +1113,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1416,6 +1431,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1441,6 +1460,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1752,6 +1774,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1847,6 +1873,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1867,6 +1897,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2105,6 +2138,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2410,6 +2446,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2521,6 +2561,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2619,6 +2663,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2715,6 +2763,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2811,6 +2863,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3009,6 +3065,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3021,6 +3078,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3192,6 +3250,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3204,6 +3263,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3437,6 +3497,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3449,6 +3510,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3620,6 +3682,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3632,6 +3695,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3797,6 +3861,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3934,6 +4002,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4586,6 +4658,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4611,6 +4687,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4919,6 +4998,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5079,6 +5162,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5091,6 +5175,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. diff --git a/docs/dyn/aiplatform_v1beta1.endpoints.html b/docs/dyn/aiplatform_v1beta1.endpoints.html index 4247735fe4..9ee4128221 100644 --- a/docs/dyn/aiplatform_v1beta1.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.endpoints.html @@ -203,6 +203,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -334,6 +338,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -485,6 +493,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -497,6 +506,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -597,6 +607,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -614,6 +628,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1002,6 +1019,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1153,6 +1174,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1165,6 +1187,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1275,6 +1298,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1308,6 +1335,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1650,6 +1680,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2031,6 +2065,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2182,6 +2220,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2194,6 +2233,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2304,6 +2344,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2337,6 +2381,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2679,6 +2726,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.interactions.html b/docs/dyn/aiplatform_v1beta1.interactions.html index 5529867238..e6e839f9c7 100644 --- a/docs/dyn/aiplatform_v1beta1.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.interactions.html @@ -192,6 +192,10 @@

Method Details

], "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. @@ -281,6 +285,10 @@

Method Details

], "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. @@ -469,6 +477,10 @@

Method Details

], "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. @@ -564,6 +576,10 @@

Method Details

], "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. @@ -681,6 +697,10 @@

Method Details

], "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. @@ -776,6 +796,10 @@

Method Details

], "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. @@ -890,6 +914,10 @@

Method Details

], "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. @@ -978,6 +1006,10 @@

Method Details

], "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. @@ -1070,6 +1102,10 @@

Method Details

], "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. @@ -1182,6 +1218,10 @@

Method Details

], "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. @@ -1304,6 +1344,10 @@

Method Details

], "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. @@ -1422,6 +1466,10 @@

Method Details

], "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. @@ -1527,6 +1575,10 @@

Method Details

], "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. @@ -1612,6 +1664,10 @@

Method Details

], "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. @@ -1700,6 +1756,10 @@

Method Details

], "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. @@ -1792,6 +1852,10 @@

Method Details

], "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. @@ -1904,6 +1968,10 @@

Method Details

], "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. @@ -2026,6 +2094,10 @@

Method Details

], "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. @@ -2144,6 +2216,10 @@

Method Details

], "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. @@ -2249,6 +2325,10 @@

Method Details

], "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. @@ -2357,6 +2437,10 @@

Method Details

], "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. @@ -2634,6 +2718,10 @@

Method Details

], "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. @@ -2723,6 +2811,10 @@

Method Details

], "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. @@ -2911,6 +3003,10 @@

Method Details

], "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. @@ -3006,6 +3102,10 @@

Method Details

], "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. @@ -3123,6 +3223,10 @@

Method Details

], "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. @@ -3218,6 +3322,10 @@

Method Details

], "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. @@ -3332,6 +3440,10 @@

Method Details

], "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. @@ -3420,6 +3532,10 @@

Method Details

], "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. @@ -3512,6 +3628,10 @@

Method Details

], "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. @@ -3624,6 +3744,10 @@

Method Details

], "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. @@ -3746,6 +3870,10 @@

Method Details

], "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. @@ -3864,6 +3992,10 @@

Method Details

], "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. @@ -3969,6 +4101,10 @@

Method Details

], "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. @@ -4054,6 +4190,10 @@

Method Details

], "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. @@ -4142,6 +4282,10 @@

Method Details

], "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. @@ -4234,6 +4378,10 @@

Method Details

], "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. @@ -4346,6 +4494,10 @@

Method Details

], "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. @@ -4468,6 +4620,10 @@

Method Details

], "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. @@ -4586,6 +4742,10 @@

Method Details

], "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. @@ -4691,6 +4851,10 @@

Method Details

], "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. @@ -4799,6 +4963,10 @@

Method Details

], "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. @@ -5080,6 +5248,10 @@

Method Details

], "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. @@ -5169,6 +5341,10 @@

Method Details

], "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. @@ -5357,6 +5533,10 @@

Method Details

], "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. @@ -5452,6 +5632,10 @@

Method Details

], "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. @@ -5569,6 +5753,10 @@

Method Details

], "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. @@ -5664,6 +5852,10 @@

Method Details

], "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. @@ -5778,6 +5970,10 @@

Method Details

], "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. @@ -5866,6 +6062,10 @@

Method Details

], "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. @@ -5958,6 +6158,10 @@

Method Details

], "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. @@ -6070,6 +6274,10 @@

Method Details

], "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. @@ -6192,6 +6400,10 @@

Method Details

], "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. @@ -6310,6 +6522,10 @@

Method Details

], "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. @@ -6415,6 +6631,10 @@

Method Details

], "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. @@ -6500,6 +6720,10 @@

Method Details

], "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. @@ -6588,6 +6812,10 @@

Method Details

], "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. @@ -6680,6 +6908,10 @@

Method Details

], "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. @@ -6792,6 +7024,10 @@

Method Details

], "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. @@ -6914,6 +7150,10 @@

Method Details

], "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. @@ -7032,6 +7272,10 @@

Method Details

], "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. @@ -7137,6 +7381,10 @@

Method Details

], "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. @@ -7245,6 +7493,10 @@

Method Details

], "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. @@ -7500,6 +7752,10 @@

Method Details

], "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. @@ -7589,6 +7845,10 @@

Method Details

], "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. @@ -7777,6 +8037,10 @@

Method Details

], "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. @@ -7872,6 +8136,10 @@

Method Details

], "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. @@ -7989,6 +8257,10 @@

Method Details

], "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. @@ -8084,6 +8356,10 @@

Method Details

], "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. @@ -8198,6 +8474,10 @@

Method Details

], "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. @@ -8286,6 +8566,10 @@

Method Details

], "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. @@ -8378,6 +8662,10 @@

Method Details

], "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. @@ -8490,6 +8778,10 @@

Method Details

], "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. @@ -8612,6 +8904,10 @@

Method Details

], "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. @@ -8730,6 +9026,10 @@

Method Details

], "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. @@ -8835,6 +9135,10 @@

Method Details

], "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. @@ -8920,6 +9224,10 @@

Method Details

], "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. @@ -9008,6 +9316,10 @@

Method Details

], "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. @@ -9100,6 +9412,10 @@

Method Details

], "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. @@ -9212,6 +9528,10 @@

Method Details

], "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. @@ -9334,6 +9654,10 @@

Method Details

], "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. @@ -9452,6 +9776,10 @@

Method Details

], "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. @@ -9557,6 +9885,10 @@

Method Details

], "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. @@ -9665,6 +9997,10 @@

Method Details

], "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. @@ -9898,6 +10234,10 @@

Method Details

], "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. @@ -10019,6 +10359,10 @@

Method Details

], "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. @@ -10172,6 +10516,10 @@

Method Details

], "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. @@ -10258,6 +10606,10 @@

Method Details

], "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. @@ -10319,6 +10671,10 @@

Method Details

], "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. @@ -10408,6 +10764,10 @@

Method Details

], "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. @@ -10496,6 +10856,10 @@

Method Details

], "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. @@ -10588,6 +10952,10 @@

Method Details

], "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. @@ -10700,6 +11068,10 @@

Method Details

], "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. @@ -10822,6 +11194,10 @@

Method Details

], "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. @@ -10940,6 +11316,10 @@

Method Details

], "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. @@ -11045,6 +11425,10 @@

Method Details

], "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. diff --git a/docs/dyn/aiplatform_v1beta1.memoryBanks.html b/docs/dyn/aiplatform_v1beta1.memoryBanks.html index f312dc96d7..9eba77319e 100644 --- a/docs/dyn/aiplatform_v1beta1.memoryBanks.html +++ b/docs/dyn/aiplatform_v1beta1.memoryBanks.html @@ -187,6 +187,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html index 7ecd6e40fb..aa0d6530c7 100644 --- a/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html +++ b/docs/dyn/aiplatform_v1beta1.memoryBanks.memories.html @@ -339,6 +339,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -386,6 +390,7 @@

Method Details

"scope": { # Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "timeZone": "A String", # Optional. The time zone of the conversation or caller, used as the baseline for resolving relative time expressions (e.g., "yesterday") and formatting timestamps. If not set, "UTC" is used. Must be a valid IANA Time Zone Database name, e.g. "America/New_York". "vertexSessionSource": { # Defines an Agent Engine Session from which to generate the memories. If `scope` is not provided, the scope will be extracted from the Session (i.e. {"user_id": sesison.user_id}). # Defines a Vertex Session as the source content from which to generate memories. "endTime": "A String", # Optional. End time (exclusive) of the time range. If not set, the end time is unbounded. "session": "A String", # Required. The resource name of the Session to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` diff --git a/docs/dyn/aiplatform_v1beta1.projects.html b/docs/dyn/aiplatform_v1beta1.projects.html index 06d1f92e43..f9a83b331c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.html +++ b/docs/dyn/aiplatform_v1beta1.projects.html @@ -102,7 +102,7 @@

Instance Methods

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

Sets (creates or updates) configs of publisher models. For example, sets the request/response logging config.

- updateCacheConfig(name, body=None, x__xgafv=None)

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

Updates a cache config.

Method Details

@@ -163,6 +163,9 @@

Method Details

{ # Config of GenAI caching features. This is a singleton resource. "disableCache": True or False, # If set to true, disables GenAI caching. Otherwise caching is enabled. "name": "A String", # Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`. + "retentionConfig": { # Configures the retention behavior of GenAI implicit (automatic) context caching for this project. # Optional. Project-level retention type for implicit caching. On `GetCacheConfig` this is populated with the retention the project gets: a project that has stated no preference reports `DURABLE`. On `UpdateCacheConfig`, leaving it unset means the project states no preference. Whether that clears an existing preference depends on `update_mask`; see that field. + "retentionType": "A String", # Optional. Retention type applied to implicit cache traffic for this project. + }, }
@@ -229,7 +232,7 @@

Method Details

- updateCacheConfig(name, body=None, x__xgafv=None) + updateCacheConfig(name, body=None, updateMask=None, x__xgafv=None)
Updates a cache config.
 
 Args:
@@ -240,8 +243,12 @@ 

Method Details

{ # Config of GenAI caching features. This is a singleton resource. "disableCache": True or False, # If set to true, disables GenAI caching. Otherwise caching is enabled. "name": "A String", # Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`. + "retentionConfig": { # Configures the retention behavior of GenAI implicit (automatic) context caching for this project. # Optional. Project-level retention type for implicit caching. On `GetCacheConfig` this is populated with the retention the project gets: a project that has stated no preference reports `DURABLE`. On `UpdateCacheConfig`, leaving it unset means the project states no preference. Whether that clears an existing preference depends on `update_mask`; see that field. + "retentionType": "A String", # Optional. Retention type applied to implicit cache traffic for this project. + }, } + updateMask: string, Optional. The list of fields of `cache_config` to update. Supported paths are `disable_cache`, `retention_config` (and its subfields such as `retention_config.retention_type`), and the special value `*`; any other path returns `INVALID_ARGUMENT`. Fields not covered by the mask keep their stored value. If the mask is omitted, it is treated as an implied mask covering the fields populated in `cache_config`, so updating one field never clears another. `retention_config` is covered only when the request carries it. `disable_cache` is always covered: it is a bare `bool`, so the server cannot tell a request that omits it from one that sets it to `false`. `*` requests full replacement of the resource: every settable field is written from the request, clearing `retention_config` when the request omits it. It cannot be combined with other paths. Prefer naming fields explicitly -- a caller that sends `*` without knowing about a field added to `CacheConfig` later would silently reset that field. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html index febf2b77ea..6c717d0896 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.agents.html @@ -141,13 +141,13 @@

Method Details

}, "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. "tools": [ # Optional. The tools available to the agent. - { # A tool provides a list of actions available to the Agent during the process of executing a task. + { # A tool provides a list of actions available to the Agent during the process of executing a task. Example JSON for an MCP server tool: { "type": "mcp_server", "name": "my-mcp-server", "url": "https://api.example.com/mcp", "headers": { "Authorization": "Bearer token123" } } "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, "name": "A String", # Optional. The tool's Google Cloud resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. + "url": "A String", # Optional. Fallback for the tool's runtime reference, consumed by `CreateAgent` to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`, and optional: the Agent service derives the runtime reference from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), and reads this only when that lookup yields none. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -249,13 +249,13 @@

Method Details

}, "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. "tools": [ # Optional. The tools available to the agent. - { # A tool provides a list of actions available to the Agent during the process of executing a task. + { # A tool provides a list of actions available to the Agent during the process of executing a task. Example JSON for an MCP server tool: { "type": "mcp_server", "name": "my-mcp-server", "url": "https://api.example.com/mcp", "headers": { "Authorization": "Bearer token123" } } "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, "name": "A String", # Optional. The tool's Google Cloud resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. + "url": "A String", # Optional. Fallback for the tool's runtime reference, consumed by `CreateAgent` to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`, and optional: the Agent service derives the runtime reference from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), and reads this only when that lookup yields none. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -334,13 +334,13 @@

Method Details

}, "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. "tools": [ # Optional. The tools available to the agent. - { # A tool provides a list of actions available to the Agent during the process of executing a task. + { # A tool provides a list of actions available to the Agent during the process of executing a task. Example JSON for an MCP server tool: { "type": "mcp_server", "name": "my-mcp-server", "url": "https://api.example.com/mcp", "headers": { "Authorization": "Bearer token123" } } "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, "name": "A String", # Optional. The tool's Google Cloud resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. + "url": "A String", # Optional. Fallback for the tool's runtime reference, consumed by `CreateAgent` to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`, and optional: the Agent service derives the runtime reference from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), and reads this only when that lookup yields none. }, ], "updated": "A String", # Output only. The time the agent was last updated. @@ -390,13 +390,13 @@

Method Details

}, "system_instruction": "A String", # Optional. The instructions for the agent to follow. These instructions are passed to the LLM as a system instruction. "tools": [ # Optional. The tools available to the agent. - { # A tool provides a list of actions available to the Agent during the process of executing a task. + { # A tool provides a list of actions available to the Agent during the process of executing a task. Example JSON for an MCP server tool: { "type": "mcp_server", "name": "my-mcp-server", "url": "https://api.example.com/mcp", "headers": { "Authorization": "Bearer token123" } } "headers": { # Optional. The headers for the MCP server, such as for authentication. Only applicable when `type` is `mcp_server`. "a_key": "A String", }, "name": "A String", # Optional. The tool's Google Cloud resource name, used to resolve the tool. Applicable when `type` is `mcp_server` or `endpoint` (a tool registered in Agent Registry), for example `projects/{project}/locations/{location}/.../mcpServers/{id}` or `projects/{project}/locations/{location}/.../endpoints/{id}`. "type": "A String", # Required. The type of the tool. Supported types: * `code_execution` * `endpoint` * `filesystem` * `google_search` * `mcp_server` * `url_context` - "url": "A String", # Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation. + "url": "A String", # Optional. Fallback for the tool's runtime reference, consumed by `CreateAgent` to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`, and optional: the Agent service derives the runtime reference from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), and reads this only when that lookup yields none. }, ], "updated": "A String", # Output only. The time the agent was last updated. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html index 64a68db747..d1e484097e 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.cachedContents.html @@ -190,6 +190,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -289,6 +293,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -322,6 +330,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -655,6 +666,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -754,6 +769,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -787,6 +806,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1145,6 +1167,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1244,6 +1270,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1277,6 +1307,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1621,6 +1654,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1720,6 +1757,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1753,6 +1794,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2105,6 +2149,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2204,6 +2252,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2237,6 +2289,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2571,6 +2626,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2670,6 +2729,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2703,6 +2766,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html index b9603f0e98..d1c56037e3 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.datasets.html @@ -245,6 +245,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -396,6 +400,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -408,6 +413,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -519,6 +525,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -552,6 +562,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -923,6 +936,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1074,6 +1091,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1086,6 +1104,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1197,6 +1216,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1230,6 +1253,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html index a3e6c0c37a..5718dbbbff 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.endpoints.html @@ -285,6 +285,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -416,6 +420,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -567,6 +575,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -579,6 +588,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -679,6 +689,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -696,6 +710,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2194,6 +2211,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2345,6 +2366,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2357,6 +2379,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2467,6 +2490,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2500,6 +2527,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2842,6 +2872,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5048,6 +5082,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5199,6 +5237,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5211,6 +5250,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5321,6 +5361,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5354,6 +5398,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -5696,6 +5743,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html index f3960489fd..95fe117bf8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationItems.html @@ -143,6 +143,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -388,6 +391,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -701,6 +707,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -813,6 +823,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -846,6 +860,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1091,6 +1108,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1404,6 +1424,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1516,6 +1540,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1548,6 +1576,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1793,6 +1824,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2106,6 +2140,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2209,6 +2247,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2306,6 +2348,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2551,6 +2596,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2864,6 +2912,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2976,6 +3028,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3009,6 +3065,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3254,6 +3313,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3567,6 +3629,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3679,6 +3745,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3711,6 +3781,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3956,6 +4029,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4269,6 +4345,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4372,6 +4452,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4460,6 +4544,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4705,6 +4792,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -5018,6 +5108,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5130,6 +5224,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5163,6 +5261,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -5408,6 +5509,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -5721,6 +5825,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5833,6 +5941,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5865,6 +5977,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -6110,6 +6225,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -6423,6 +6541,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6526,6 +6648,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6623,6 +6749,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -6868,6 +6997,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7181,6 +7313,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7293,6 +7429,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7326,6 +7466,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7571,6 +7714,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7884,6 +8030,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7996,6 +8146,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8028,6 +8182,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8273,6 +8430,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8586,6 +8746,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8689,6 +8853,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8819,6 +8987,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9064,6 +9235,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9377,6 +9551,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -9489,6 +9667,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -9522,6 +9704,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9767,6 +9952,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -10080,6 +10268,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -10192,6 +10384,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -10224,6 +10420,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -10469,6 +10668,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -10782,6 +10984,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -10885,6 +11091,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -10982,6 +11192,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -11227,6 +11440,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -11540,6 +11756,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11652,6 +11872,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11685,6 +11909,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -11930,6 +12157,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -12243,6 +12473,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12355,6 +12589,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12387,6 +12625,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -12632,6 +12873,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -12945,6 +13189,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -13048,6 +13296,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -13149,6 +13401,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -13394,6 +13649,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -13707,6 +13965,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -13819,6 +14081,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -13852,6 +14118,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -14097,6 +14366,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -14410,6 +14682,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -14522,6 +14798,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -14554,6 +14834,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -14799,6 +15082,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -15112,6 +15398,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -15215,6 +15505,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -15312,6 +15606,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -15557,6 +15854,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -15870,6 +16170,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -15982,6 +16286,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -16015,6 +16323,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -16260,6 +16571,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -16573,6 +16887,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -16685,6 +17003,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -16717,6 +17039,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -16962,6 +17287,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -17275,6 +17603,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -17378,6 +17710,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html index b918d765bc..559286f9e4 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationMetrics.html @@ -287,6 +287,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -299,6 +300,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -474,6 +476,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -486,6 +489,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -743,6 +747,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -755,6 +760,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -930,6 +936,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -942,6 +949,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1240,6 +1248,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1252,6 +1261,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1427,6 +1437,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1439,6 +1450,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1708,6 +1720,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1720,6 +1733,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1895,6 +1909,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1907,6 +1922,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html index ac8d7e1f94..34819228fe 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationRuns.html @@ -312,6 +312,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -324,6 +325,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -520,6 +522,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -532,6 +535,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -701,6 +705,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -713,6 +718,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -907,6 +913,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -919,6 +926,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1094,6 +1102,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1106,6 +1115,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1337,6 +1347,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1349,6 +1360,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1512,6 +1524,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1524,6 +1537,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1716,6 +1730,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1728,6 +1743,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1827,6 +1843,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2072,6 +2091,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2385,6 +2407,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2497,6 +2523,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2530,6 +2560,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2775,6 +2808,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3088,6 +3124,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3200,6 +3240,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3232,6 +3276,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3477,6 +3524,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3790,6 +3840,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3893,6 +3947,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4046,6 +4104,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4063,6 +4125,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4455,6 +4520,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4467,6 +4533,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4502,6 +4569,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4876,6 +4946,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4888,6 +4959,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5103,6 +5175,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5115,6 +5188,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5311,6 +5385,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5323,6 +5398,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5492,6 +5568,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5504,6 +5581,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5698,6 +5776,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5710,6 +5789,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5885,6 +5965,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5897,6 +5978,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6128,6 +6210,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6140,6 +6223,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6303,6 +6387,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6315,6 +6400,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6507,6 +6593,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6519,6 +6606,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6618,6 +6706,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -6863,6 +6954,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7176,6 +7270,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7288,6 +7386,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7321,6 +7423,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7566,6 +7671,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7879,6 +7987,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7991,6 +8103,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8023,6 +8139,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8268,6 +8387,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8581,6 +8703,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8684,6 +8810,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8837,6 +8967,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8854,6 +8988,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9246,6 +9383,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -9258,6 +9396,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -9293,6 +9432,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9667,6 +9809,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -9679,6 +9822,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -9936,6 +10080,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -9948,6 +10093,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -10144,6 +10290,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -10156,6 +10303,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -10325,6 +10473,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -10337,6 +10486,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -10531,6 +10681,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -10543,6 +10694,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -10718,6 +10870,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -10730,6 +10883,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -10961,6 +11115,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -10973,6 +11128,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -11136,6 +11292,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -11148,6 +11305,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -11340,6 +11498,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -11352,6 +11511,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -11451,6 +11611,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -11696,6 +11859,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -12009,6 +12175,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12121,6 +12291,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12154,6 +12328,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -12399,6 +12576,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -12712,6 +12892,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12824,6 +13008,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12856,6 +13044,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -13101,6 +13292,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -13414,6 +13608,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -13517,6 +13715,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -13670,6 +13872,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -13687,6 +13893,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -14079,6 +14288,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -14091,6 +14301,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -14126,6 +14337,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -14500,6 +14714,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -14512,6 +14727,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -14740,6 +14956,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -14752,6 +14969,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -14948,6 +15166,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -14960,6 +15179,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -15129,6 +15349,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -15141,6 +15362,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -15335,6 +15557,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -15347,6 +15570,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -15522,6 +15746,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -15534,6 +15759,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -15765,6 +15991,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -15777,6 +16004,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -15940,6 +16168,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -15952,6 +16181,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -16144,6 +16374,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -16156,6 +16387,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -16255,6 +16487,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -16500,6 +16735,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -16813,6 +17051,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -16925,6 +17167,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -16958,6 +17204,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -17203,6 +17452,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -17516,6 +17768,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -17628,6 +17884,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -17660,6 +17920,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -17905,6 +18168,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -18218,6 +18484,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -18321,6 +18591,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -18474,6 +18748,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -18491,6 +18769,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -18883,6 +19164,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -18895,6 +19177,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -18930,6 +19213,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -19304,6 +19590,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -19316,6 +19603,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html index 5de3b9764b..a7f74c1981 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.evaluationSets.html @@ -133,6 +133,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -405,6 +408,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -719,6 +725,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1025,6 +1034,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1364,6 +1376,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1655,6 +1670,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1928,6 +1946,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html index c8c2ccca25..9da8ff94ba 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.exampleStores.html @@ -320,6 +320,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -413,6 +417,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -710,6 +718,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -835,6 +847,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -928,6 +944,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1052,6 +1072,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1145,6 +1169,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1267,6 +1295,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1360,6 +1392,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html index 169807aa30..daa1a7a932 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.extensions.html @@ -1228,6 +1228,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1332,6 +1336,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.html b/docs/dyn/aiplatform_v1beta1.projects.locations.html index 16f162d2ce..188703cdea 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.html @@ -369,6 +369,11 @@

Instance Methods

Returns the tuningJobs Resource.

+

+ voices() +

+

Returns the voices Resource.

+

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

Agentic Retrieval Ask API for RAG.

@@ -477,6 +482,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -788,6 +796,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1142,6 +1153,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1284,6 +1299,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1412,6 +1431,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1959,6 +1982,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1971,6 +1995,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2167,6 +2192,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2179,6 +2205,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2354,6 +2381,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2366,6 +2394,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2623,6 +2652,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2635,6 +2665,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2809,6 +2840,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2834,6 +2869,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3157,6 +3195,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3182,6 +3224,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3501,6 +3546,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3597,6 +3646,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3617,6 +3670,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3862,6 +3918,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4175,6 +4234,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4213,6 +4276,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4458,6 +4524,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -4771,6 +4840,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4883,6 +4956,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4982,6 +5059,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5079,6 +5160,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5176,6 +5261,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5378,6 +5467,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5390,6 +5480,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5565,6 +5656,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5577,6 +5669,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -5814,6 +5907,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5826,6 +5920,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6001,6 +6096,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6013,6 +6109,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6179,6 +6276,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6317,6 +6418,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6971,6 +7076,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6996,6 +7105,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7312,6 +7424,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7475,6 +7591,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -7487,6 +7604,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -7615,6 +7733,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -7860,6 +7981,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8173,6 +8297,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8285,6 +8413,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8318,6 +8450,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8563,6 +8698,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8876,6 +9014,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8988,6 +9130,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -9020,6 +9166,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9265,6 +9414,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9578,6 +9730,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -9681,6 +9837,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -9848,6 +10008,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -9968,6 +10132,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -10012,6 +10180,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html index 0ba79a0778..a42f1a350c 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.interactions.html @@ -195,6 +195,10 @@

Method Details

], "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. @@ -284,6 +288,10 @@

Method Details

], "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. @@ -472,6 +480,10 @@

Method Details

], "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. @@ -567,6 +579,10 @@

Method Details

], "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. @@ -684,6 +700,10 @@

Method Details

], "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. @@ -779,6 +799,10 @@

Method Details

], "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. @@ -893,6 +917,10 @@

Method Details

], "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. @@ -981,6 +1009,10 @@

Method Details

], "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. @@ -1073,6 +1105,10 @@

Method Details

], "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. @@ -1185,6 +1221,10 @@

Method Details

], "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. @@ -1307,6 +1347,10 @@

Method Details

], "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. @@ -1425,6 +1469,10 @@

Method Details

], "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. @@ -1530,6 +1578,10 @@

Method Details

], "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. @@ -1615,6 +1667,10 @@

Method Details

], "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. @@ -1703,6 +1759,10 @@

Method Details

], "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. @@ -1795,6 +1855,10 @@

Method Details

], "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. @@ -1907,6 +1971,10 @@

Method Details

], "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. @@ -2029,6 +2097,10 @@

Method Details

], "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. @@ -2147,6 +2219,10 @@

Method Details

], "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. @@ -2252,6 +2328,10 @@

Method Details

], "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. @@ -2360,6 +2440,10 @@

Method Details

], "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. @@ -2625,6 +2709,10 @@

Method Details

], "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. @@ -2714,6 +2802,10 @@

Method Details

], "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. @@ -2902,6 +2994,10 @@

Method Details

], "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. @@ -2997,6 +3093,10 @@

Method Details

], "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. @@ -3114,6 +3214,10 @@

Method Details

], "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. @@ -3209,6 +3313,10 @@

Method Details

], "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. @@ -3323,6 +3431,10 @@

Method Details

], "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. @@ -3411,6 +3523,10 @@

Method Details

], "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. @@ -3503,6 +3619,10 @@

Method Details

], "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. @@ -3615,6 +3735,10 @@

Method Details

], "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. @@ -3737,6 +3861,10 @@

Method Details

], "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. @@ -3855,6 +3983,10 @@

Method Details

], "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. @@ -3960,6 +4092,10 @@

Method Details

], "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. @@ -4045,6 +4181,10 @@

Method Details

], "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. @@ -4133,6 +4273,10 @@

Method Details

], "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. @@ -4225,6 +4369,10 @@

Method Details

], "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. @@ -4337,6 +4485,10 @@

Method Details

], "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. @@ -4459,6 +4611,10 @@

Method Details

], "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. @@ -4577,6 +4733,10 @@

Method Details

], "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. @@ -4682,6 +4842,10 @@

Method Details

], "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. @@ -4790,6 +4954,10 @@

Method Details

], "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. @@ -5057,6 +5225,10 @@

Method Details

], "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. @@ -5146,6 +5318,10 @@

Method Details

], "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. @@ -5334,6 +5510,10 @@

Method Details

], "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. @@ -5429,6 +5609,10 @@

Method Details

], "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. @@ -5546,6 +5730,10 @@

Method Details

], "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. @@ -5641,6 +5829,10 @@

Method Details

], "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. @@ -5755,6 +5947,10 @@

Method Details

], "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. @@ -5843,6 +6039,10 @@

Method Details

], "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. @@ -5935,6 +6135,10 @@

Method Details

], "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. @@ -6047,6 +6251,10 @@

Method Details

], "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. @@ -6169,6 +6377,10 @@

Method Details

], "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. @@ -6287,6 +6499,10 @@

Method Details

], "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. @@ -6392,6 +6608,10 @@

Method Details

], "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. @@ -6477,6 +6697,10 @@

Method Details

], "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. @@ -6565,6 +6789,10 @@

Method Details

], "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. @@ -6657,6 +6885,10 @@

Method Details

], "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. @@ -6769,6 +7001,10 @@

Method Details

], "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. @@ -6891,6 +7127,10 @@

Method Details

], "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. @@ -7009,6 +7249,10 @@

Method Details

], "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. @@ -7114,6 +7358,10 @@

Method Details

], "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. @@ -7222,6 +7470,10 @@

Method Details

], "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. @@ -7496,6 +7748,10 @@

Method Details

], "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. @@ -7585,6 +7841,10 @@

Method Details

], "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. @@ -7773,6 +8033,10 @@

Method Details

], "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. @@ -7868,6 +8132,10 @@

Method Details

], "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. @@ -7985,6 +8253,10 @@

Method Details

], "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. @@ -8080,6 +8352,10 @@

Method Details

], "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. @@ -8194,6 +8470,10 @@

Method Details

], "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. @@ -8282,6 +8562,10 @@

Method Details

], "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. @@ -8374,6 +8658,10 @@

Method Details

], "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. @@ -8486,6 +8774,10 @@

Method Details

], "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. @@ -8608,6 +8900,10 @@

Method Details

], "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. @@ -8726,6 +9022,10 @@

Method Details

], "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. @@ -8831,6 +9131,10 @@

Method Details

], "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. @@ -8916,6 +9220,10 @@

Method Details

], "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. @@ -9004,6 +9312,10 @@

Method Details

], "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. @@ -9096,6 +9408,10 @@

Method Details

], "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. @@ -9208,6 +9524,10 @@

Method Details

], "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. @@ -9330,6 +9650,10 @@

Method Details

], "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. @@ -9448,6 +9772,10 @@

Method Details

], "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. @@ -9553,6 +9881,10 @@

Method Details

], "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. @@ -9661,6 +9993,10 @@

Method Details

], "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. @@ -9916,6 +10252,10 @@

Method Details

], "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. @@ -10005,6 +10345,10 @@

Method Details

], "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. @@ -10193,6 +10537,10 @@

Method Details

], "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. @@ -10288,6 +10636,10 @@

Method Details

], "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. @@ -10405,6 +10757,10 @@

Method Details

], "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. @@ -10500,6 +10856,10 @@

Method Details

], "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. @@ -10614,6 +10974,10 @@

Method Details

], "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. @@ -10702,6 +11066,10 @@

Method Details

], "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. @@ -10794,6 +11162,10 @@

Method Details

], "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. @@ -10906,6 +11278,10 @@

Method Details

], "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. @@ -11028,6 +11404,10 @@

Method Details

], "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. @@ -11146,6 +11526,10 @@

Method Details

], "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. @@ -11251,6 +11635,10 @@

Method Details

], "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. @@ -11336,6 +11724,10 @@

Method Details

], "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. @@ -11424,6 +11816,10 @@

Method Details

], "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. @@ -11516,6 +11912,10 @@

Method Details

], "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. @@ -11628,6 +12028,10 @@

Method Details

], "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. @@ -11750,6 +12154,10 @@

Method Details

], "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. @@ -11868,6 +12276,10 @@

Method Details

], "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. @@ -11973,6 +12385,10 @@

Method Details

], "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. @@ -12081,6 +12497,10 @@

Method Details

], "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. @@ -12314,6 +12734,10 @@

Method Details

], "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. @@ -12435,6 +12859,10 @@

Method Details

], "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. @@ -12588,6 +13016,10 @@

Method Details

], "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. @@ -12674,6 +13106,10 @@

Method Details

], "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. @@ -12735,6 +13171,10 @@

Method Details

], "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. @@ -12824,6 +13264,10 @@

Method Details

], "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. @@ -12912,6 +13356,10 @@

Method Details

], "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. @@ -13004,6 +13452,10 @@

Method Details

], "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. @@ -13116,6 +13568,10 @@

Method Details

], "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. @@ -13238,6 +13694,10 @@

Method Details

], "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. @@ -13356,6 +13816,10 @@

Method Details

], "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. @@ -13461,6 +13925,10 @@

Method Details

], "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. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html index bceda06fb3..94e2dfe83a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.html @@ -187,6 +187,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html index 5519abd8a9..ff53202b82 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.memoryBanks.memories.html @@ -339,6 +339,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -386,6 +390,7 @@

Method Details

"scope": { # Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "timeZone": "A String", # Optional. The time zone of the conversation or caller, used as the baseline for resolving relative time expressions (e.g., "yesterday") and formatting timestamps. If not set, "UTC" is used. Must be a valid IANA Time Zone Database name, e.g. "America/New_York". "vertexSessionSource": { # Defines an Agent Engine Session from which to generate the memories. If `scope` is not provided, the scope will be extracted from the Session (i.e. {"user_id": sesison.user_id}). # Defines a Vertex Session as the source content from which to generate memories. "endTime": "A String", # Optional. End time (exclusive) of the time range. If not set, the end time is unbounded. "session": "A String", # Required. The resource name of the Session to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html index 1a1bff2649..8885e31d80 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.onlineEvaluators.html @@ -396,6 +396,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -408,6 +409,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -583,6 +585,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -595,6 +598,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -989,6 +993,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1001,6 +1006,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1176,6 +1182,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1188,6 +1195,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1526,6 +1534,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1538,6 +1547,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1713,6 +1723,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1725,6 +1736,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2067,6 +2079,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2079,6 +2092,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2254,6 +2268,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2266,6 +2281,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html index 2891d194ab..923f38961d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.publishers.models.html @@ -222,6 +222,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -353,6 +357,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -504,6 +512,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -516,6 +525,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -616,6 +626,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -633,6 +647,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -978,6 +995,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1267,6 +1288,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1418,6 +1443,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1430,6 +1456,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1540,6 +1567,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1573,6 +1604,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1915,6 +1949,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2621,6 +2659,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2772,6 +2814,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -2784,6 +2827,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -2894,6 +2938,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2927,6 +2975,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3269,6 +3320,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.events.html index 8145be818c..98c85bc5ff 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.events.html @@ -315,6 +315,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -415,6 +419,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -516,6 +524,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html index abc9b8688b..efaedeae66 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.a2aTasks.html @@ -318,6 +318,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -418,6 +422,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -519,6 +527,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -721,6 +733,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -850,6 +866,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1032,6 +1052,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1161,6 +1185,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1372,6 +1400,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1501,6 +1533,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1695,6 +1731,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1824,6 +1864,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html index d043383df5..f791da74ca 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.feedbackEntries.html @@ -346,6 +346,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -704,6 +708,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html index 73e1bf49d2..052c345b5b 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.html @@ -350,6 +350,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -832,6 +836,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1245,6 +1253,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1628,6 +1640,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html index 75ac6d874e..360e2edf32 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.memories.html @@ -342,6 +342,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -389,6 +393,7 @@

Method Details

"scope": { # Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "timeZone": "A String", # Optional. The time zone of the conversation or caller, used as the baseline for resolving relative time expressions (e.g., "yesterday") and formatting timestamps. If not set, "UTC" is used. Must be a valid IANA Time Zone Database name, e.g. "America/New_York". "vertexSessionSource": { # Defines an Agent Engine Session from which to generate the memories. If `scope` is not provided, the scope will be extracted from the Session (i.e. {"user_id": sesison.user_id}). # Defines a Vertex Session as the source content from which to generate memories. "endTime": "A String", # Optional. End time (exclusive) of the time range. If not set, the end time is unbounded. "session": "A String", # Required. The resource name of the Session to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` @@ -573,6 +578,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html index 3fb0408356..73ca1e632d 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sandboxEnvironmentTemplates.html @@ -177,6 +177,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "persistentDiskConfig": { # Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. A persistent disk provides durable, per-sandbox block storage whose contents survive across the sandbox lifecycle events that this service supports (e.g. pause/resume), unlike ephemeral local storage which is lost when the underlying runtime is torn down. # Optional. Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. When unset (or when `enabled` is `false`), sandboxes created from this template are not backed by a persistent disk and rely on ephemeral storage only. See PersistentDiskConfig for details. "enabled": True or False, # Optional. Whether a persistent disk is attached to sandboxes created from this template. Defaults to `false`. This flag lets a template carry (and preserve) disk configuration while keeping the disk detached, so it can be toggled on later without re-specifying the rest of the config. When `false`, the remaining fields in this message are ignored. + "mountPath": "A String", # Optional. The absolute path inside the sandbox container at which the persistent disk is mounted. Defaults to `/workspace` when unset. Ignored when `enabled` is `false`. Only writes beneath this path land on the disk. Writes elsewhere go to the container's writable layer, which counts against the container's ephemeral storage and is lost when the sandbox's runtime is torn down, so this should be the directory the workload actually writes to. Paths that would shadow the container's system directories (for example `/etc`, `/proc`, or `/usr` itself) are rejected. "sizeGb": "A String", # Optional. The size of the persistent disk in GB. Must be non-negative. When `enabled` is `true`, a positive value is required; when unset or zero while enabled, the service applies a default size. Ignored when `enabled` is `false`. }, "state": "A String", # Output only. The state of the sandbox environment template. @@ -327,6 +328,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "persistentDiskConfig": { # Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. A persistent disk provides durable, per-sandbox block storage whose contents survive across the sandbox lifecycle events that this service supports (e.g. pause/resume), unlike ephemeral local storage which is lost when the underlying runtime is torn down. # Optional. Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. When unset (or when `enabled` is `false`), sandboxes created from this template are not backed by a persistent disk and rely on ephemeral storage only. See PersistentDiskConfig for details. "enabled": True or False, # Optional. Whether a persistent disk is attached to sandboxes created from this template. Defaults to `false`. This flag lets a template carry (and preserve) disk configuration while keeping the disk detached, so it can be toggled on later without re-specifying the rest of the config. When `false`, the remaining fields in this message are ignored. + "mountPath": "A String", # Optional. The absolute path inside the sandbox container at which the persistent disk is mounted. Defaults to `/workspace` when unset. Ignored when `enabled` is `false`. Only writes beneath this path land on the disk. Writes elsewhere go to the container's writable layer, which counts against the container's ephemeral storage and is lost when the sandbox's runtime is torn down, so this should be the directory the workload actually writes to. Paths that would shadow the container's system directories (for example `/etc`, `/proc`, or `/usr` itself) are rejected. "sizeGb": "A String", # Optional. The size of the persistent disk in GB. Must be non-negative. When `enabled` is `true`, a positive value is required; when unset or zero while enabled, the service applies a default size. Ignored when `enabled` is `false`. }, "state": "A String", # Output only. The state of the sandbox environment template. @@ -420,6 +422,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "persistentDiskConfig": { # Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. A persistent disk provides durable, per-sandbox block storage whose contents survive across the sandbox lifecycle events that this service supports (e.g. pause/resume), unlike ephemeral local storage which is lost when the underlying runtime is torn down. # Optional. Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. When unset (or when `enabled` is `false`), sandboxes created from this template are not backed by a persistent disk and rely on ephemeral storage only. See PersistentDiskConfig for details. "enabled": True or False, # Optional. Whether a persistent disk is attached to sandboxes created from this template. Defaults to `false`. This flag lets a template carry (and preserve) disk configuration while keeping the disk detached, so it can be toggled on later without re-specifying the rest of the config. When `false`, the remaining fields in this message are ignored. + "mountPath": "A String", # Optional. The absolute path inside the sandbox container at which the persistent disk is mounted. Defaults to `/workspace` when unset. Ignored when `enabled` is `false`. Only writes beneath this path land on the disk. Writes elsewhere go to the container's writable layer, which counts against the container's ephemeral storage and is lost when the sandbox's runtime is torn down, so this should be the directory the workload actually writes to. Paths that would shadow the container's system directories (for example `/etc`, `/proc`, or `/usr` itself) are rejected. "sizeGb": "A String", # Optional. The size of the persistent disk in GB. Must be non-negative. When `enabled` is `true`, a positive value is required; when unset or zero while enabled, the service applies a default size. Ignored when `enabled` is `false`. }, "state": "A String", # Output only. The state of the sandbox environment template. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html index 9695ab9935..5508da395a 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.events.html @@ -204,6 +204,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html index cf12c72880..1cd55f10f8 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.reasoningEngines.sessions.html @@ -215,6 +215,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html index 68a146653d..1243865fae 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.semanticGovernancePolicies.html @@ -124,6 +124,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. + "dryRun": True or False, # Optional. If true, this policy is evaluated and its result is reported, but the policy is not enforced: a violation does not block the agent's action. Use this to validate a policy against real traffic before turning enforcement on. Defaults to `false`, meaning the policy is enforced. This setting applies only to this policy. If the SemanticGovernancePolicyEngine for the project is itself in dry run, every policy behaves as dry run regardless of this field. "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned. "mcpTools": [ # Optional. The McpTools that are affected by this policy. { # Represents a governance policy applied to MCP tools used by an Agent. @@ -227,6 +228,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. + "dryRun": True or False, # Optional. If true, this policy is evaluated and its result is reported, but the policy is not enforced: a violation does not block the agent's action. Use this to validate a policy against real traffic before turning enforcement on. Defaults to `false`, meaning the policy is enforced. This setting applies only to this policy. If the SemanticGovernancePolicyEngine for the project is itself in dry run, every policy behaves as dry run regardless of this field. "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned. "mcpTools": [ # Optional. The McpTools that are affected by this policy. { # Represents a governance policy applied to MCP tools used by an Agent. @@ -270,6 +272,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. + "dryRun": True or False, # Optional. If true, this policy is evaluated and its result is reported, but the policy is not enforced: a violation does not block the agent's action. Use this to validate a policy against real traffic before turning enforcement on. Defaults to `false`, meaning the policy is enforced. This setting applies only to this policy. If the SemanticGovernancePolicyEngine for the project is itself in dry run, every policy behaves as dry run regardless of this field. "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned. "mcpTools": [ # Optional. The McpTools that are affected by this policy. { # Represents a governance policy applied to MCP tools used by an Agent. @@ -319,6 +322,7 @@

Method Details

"createTime": "A String", # Output only. Timestamp when this SemanticGovernancePolicy was created. "description": "A String", # Optional. The description of the SemanticGovernancePolicy. "displayName": "A String", # Optional. The user-defined name of the SemanticGovernancePolicy. + "dryRun": True or False, # Optional. If true, this policy is evaluated and its result is reported, but the policy is not enforced: a violation does not block the agent's action. Use this to validate a policy against real traffic before turning enforcement on. Defaults to `false`, meaning the policy is enforced. This setting applies only to this policy. If the SemanticGovernancePolicyEngine for the project is itself in dry run, every policy behaves as dry run regardless of this field. "etag": "A String", # Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned. "mcpTools": [ # Optional. The McpTools that are affected by this policy. { # Represents a governance policy applied to MCP tools used by an Agent. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html index 7d216231ad..ed2e181944 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.taskStores.a2aTaskRecords.html @@ -313,8 +313,8 @@

Method Details

"serviceMetadata": { # Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication. "a_key": "", # Properties of the object. }, - "status": { # Represents the status of an A2ATaskRecord. # Output only. The status of the task, including the state, status message, and timestamp. - "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Output only. The status message associated with the state. + "status": { # Represents the status of an A2ATaskRecord. # Optional. The status of the task, including the state, status message, and timestamp. + "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The status message associated with the state. "extensions": [ # Optional. A2A protocol extensions associated with the message. "A String", ], @@ -340,15 +340,15 @@

Method Details

], "role": "A String", # Required. The role of the sender of the message. }, - "state": "A String", # Output only. The current state of the task. + "state": "A String", # Optional. The current state of the task. "timestamp": "A String", # Output only. The time at which the state was set. }, - "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days] + "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: [1 second, 1000 days], at second precision. The `nanos` component MUST be zero; sub-second TTLs are not supported because the task's expiration is persisted at second granularity. "updateTime": "A String", # Output only. The last update timestamp of the task. "userId": "A String", # Optional. Task owner user ID. } - a2aTaskRecordId: string, Optional. The user defined ID to use for the A2ATaskRecord, which will become the final component of the A2ATaskRecord resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number. + a2aTaskRecordId: string, Optional. The user defined ID to use for the A2ATaskRecord, which will become the final component of the A2ATaskRecord resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number. This accepts A2A task IDs such as UUIDs, which may start with a digit. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -426,8 +426,8 @@

Method Details

"serviceMetadata": { # Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication. "a_key": "", # Properties of the object. }, - "status": { # Represents the status of an A2ATaskRecord. # Output only. The status of the task, including the state, status message, and timestamp. - "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Output only. The status message associated with the state. + "status": { # Represents the status of an A2ATaskRecord. # Optional. The status of the task, including the state, status message, and timestamp. + "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The status message associated with the state. "extensions": [ # Optional. A2A protocol extensions associated with the message. "A String", ], @@ -453,10 +453,10 @@

Method Details

], "role": "A String", # Required. The role of the sender of the message. }, - "state": "A String", # Output only. The current state of the task. + "state": "A String", # Optional. The current state of the task. "timestamp": "A String", # Output only. The time at which the state was set. }, - "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days] + "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: [1 second, 1000 days], at second precision. The `nanos` component MUST be zero; sub-second TTLs are not supported because the task's expiration is persisted at second granularity. "updateTime": "A String", # Output only. The last update timestamp of the task. "userId": "A String", # Optional. Task owner user ID. }
@@ -545,8 +545,8 @@

Method Details

"serviceMetadata": { # Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication. "a_key": "", # Properties of the object. }, - "status": { # Represents the status of an A2ATaskRecord. # Output only. The status of the task, including the state, status message, and timestamp. - "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Output only. The status message associated with the state. + "status": { # Represents the status of an A2ATaskRecord. # Optional. The status of the task, including the state, status message, and timestamp. + "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The status message associated with the state. "extensions": [ # Optional. A2A protocol extensions associated with the message. "A String", ], @@ -572,10 +572,10 @@

Method Details

], "role": "A String", # Required. The role of the sender of the message. }, - "state": "A String", # Output only. The current state of the task. + "state": "A String", # Optional. The current state of the task. "timestamp": "A String", # Output only. The time at which the state was set. }, - "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days] + "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: [1 second, 1000 days], at second precision. The `nanos` component MUST be zero; sub-second TTLs are not supported because the task's expiration is persisted at second granularity. "updateTime": "A String", # Output only. The last update timestamp of the task. "userId": "A String", # Optional. Task owner user ID. } @@ -669,8 +669,8 @@

Method Details

"serviceMetadata": { # Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication. "a_key": "", # Properties of the object. }, - "status": { # Represents the status of an A2ATaskRecord. # Output only. The status of the task, including the state, status message, and timestamp. - "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Output only. The status message associated with the state. + "status": { # Represents the status of an A2ATaskRecord. # Optional. The status of the task, including the state, status message, and timestamp. + "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The status message associated with the state. "extensions": [ # Optional. A2A protocol extensions associated with the message. "A String", ], @@ -696,10 +696,10 @@

Method Details

], "role": "A String", # Required. The role of the sender of the message. }, - "state": "A String", # Output only. The current state of the task. + "state": "A String", # Optional. The current state of the task. "timestamp": "A String", # Output only. The time at which the state was set. }, - "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days] + "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: [1 second, 1000 days], at second precision. The `nanos` component MUST be zero; sub-second TTLs are not supported because the task's expiration is persisted at second granularity. "updateTime": "A String", # Output only. The last update timestamp of the task. "userId": "A String", # Optional. Task owner user ID. } @@ -794,8 +794,8 @@

Method Details

"serviceMetadata": { # Optional. Metadata relevant to the A2ATaskRecordService, not the agent to agent communication. "a_key": "", # Properties of the object. }, - "status": { # Represents the status of an A2ATaskRecord. # Output only. The status of the task, including the state, status message, and timestamp. - "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Output only. The status message associated with the state. + "status": { # Represents the status of an A2ATaskRecord. # Optional. The status of the task, including the state, status message, and timestamp. + "message": { # Represents a single message in a conversation, compliant with the A2A specification. # Optional. The status message associated with the state. "extensions": [ # Optional. A2A protocol extensions associated with the message. "A String", ], @@ -821,10 +821,10 @@

Method Details

], "role": "A String", # Required. The role of the sender of the message. }, - "state": "A String", # Output only. The current state of the task. + "state": "A String", # Optional. The current state of the task. "timestamp": "A String", # Output only. The time at which the state was set. }, - "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days] + "ttl": "A String", # Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: [1 second, 1000 days], at second precision. The `nanos` component MUST be zero; sub-second TTLs are not supported because the task's expiration is persisted at second granularity. "updateTime": "A String", # Output only. The last update timestamp of the task. "userId": "A String", # Optional. Task owner user ID. }, diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html index 551042af3c..a22a34b188 100644 --- a/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.tuningJobs.html @@ -267,6 +267,7 @@

Method Details

"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. }, + "gcsMetricsUri": "A String", # Output only. The Cloud Storage metrics URI associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", }, @@ -443,6 +444,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -455,6 +457,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -675,6 +678,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -687,6 +691,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -898,6 +903,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -910,6 +916,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1074,6 +1081,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1086,6 +1094,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1269,6 +1278,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1281,6 +1291,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1456,6 +1467,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1468,6 +1480,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1676,6 +1689,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1770,6 +1787,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1787,6 +1808,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2108,6 +2132,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2295,6 +2323,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2389,6 +2421,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2542,6 +2578,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2636,6 +2676,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2653,6 +2697,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2974,6 +3021,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3128,6 +3179,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3354,6 +3409,7 @@

Method Details

"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. }, + "gcsMetricsUri": "A String", # Output only. The Cloud Storage metrics URI associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", }, @@ -3530,6 +3586,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3542,6 +3599,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3762,6 +3820,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3774,6 +3833,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3985,6 +4045,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3997,6 +4058,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4161,6 +4223,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4173,6 +4236,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4356,6 +4420,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4368,6 +4433,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4543,6 +4609,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4555,6 +4622,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4763,6 +4831,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4857,6 +4929,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4874,6 +4950,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -5195,6 +5274,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5382,6 +5465,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5476,6 +5563,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5629,6 +5720,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5723,6 +5818,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5740,6 +5839,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -6061,6 +6163,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6215,6 +6321,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -6448,6 +6558,7 @@

Method Details

"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. }, + "gcsMetricsUri": "A String", # Output only. The Cloud Storage metrics URI associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", }, @@ -6624,6 +6735,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6636,6 +6748,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -6856,6 +6969,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -6868,6 +6982,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -7079,6 +7194,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -7091,6 +7207,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -7255,6 +7372,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -7267,6 +7385,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -7450,6 +7569,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -7462,6 +7582,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -7637,6 +7758,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -7649,6 +7771,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -7857,6 +7980,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7951,6 +8078,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -7968,6 +8099,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -8289,6 +8423,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8476,6 +8614,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8570,6 +8712,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8723,6 +8869,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8817,6 +8967,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -8834,6 +8988,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -9155,6 +9312,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -9309,6 +9470,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -9548,6 +9713,7 @@

Method Details

"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. }, + "gcsMetricsUri": "A String", # Output only. The Cloud Storage metrics URI associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", }, @@ -9724,6 +9890,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -9736,6 +9903,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -9956,6 +10124,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -9968,6 +10137,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -10179,6 +10349,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -10191,6 +10362,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -10355,6 +10527,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -10367,6 +10540,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -10550,6 +10724,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -10562,6 +10737,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -10737,6 +10913,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -10749,6 +10926,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -10957,6 +11135,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11051,6 +11233,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11068,6 +11254,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -11389,6 +11578,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11576,6 +11769,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11670,6 +11867,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11823,6 +12024,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11917,6 +12122,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -11934,6 +12143,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -12255,6 +12467,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12409,6 +12625,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12613,6 +12833,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12715,6 +12939,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -12751,6 +12979,7 @@

Method Details

"inputBucketProjectNumber": "A String", # Optional. The project number of the project that the user expects to own the input Cloud Storage bucket referenced by gcs_source. The service verifies that the bucket is actually owned by this project before reading from it, in order to prevent bucket squatting. If unset, the bucket is verified to be owned by the project the request is made for (parent). "outputBucketProjectNumber": "A String", # Optional. The project number of the project that the user expects to own the output Cloud Storage bucket referenced by gcs_destination. The service verifies that the bucket is actually owned by this project before writing to it, in order to prevent bucket squatting. If unset, the bucket is verified to be owned by the project the request is made for (parent). "veoSpec": { # Spec for Veo data processing. # Optional. Spec for Veo data processing. + "outpaintingMode": "A String", # Optional. The mode of Veo Outpainting data processing to perform. Required (`DATA_PREPARATION` or `OUTPAINTING`) when `process_type` is `VEO_OUTPAINTING` (`OUTPAINTING_MODE_UNSPECIFIED` is rejected with `INVALID_ARGUMENT`). Must not be set when `process_type` is not `VEO_OUTPAINTING` (rejected with `INVALID_ARGUMENT`). "processType": "A String", # Optional. The type of data processing to perform. }, } @@ -12922,6 +13151,7 @@

Method Details

"trainingDatasetUri": "A String", # Required. Training dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. "validationDatasetUri": "A String", # Optional. Validation dataset used for tuning. The dataset can be specified as either a Cloud Storage path to a JSONL file or as the resource name of a Vertex Multimodal Dataset. }, + "gcsMetricsUri": "A String", # Output only. The Cloud Storage metrics URI associated with this TuningJob. "labels": { # Optional. The labels with user-defined metadata to organize TuningJob and generated resources such as Model and Endpoint. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. See https://goo.gl/xmQnxf for more information and examples of labels. "a_key": "A String", }, @@ -13098,6 +13328,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -13110,6 +13341,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -13330,6 +13562,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -13342,6 +13575,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -13553,6 +13787,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -13565,6 +13800,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -13729,6 +13965,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -13741,6 +13978,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -13924,6 +14162,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -13936,6 +14175,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -14111,6 +14351,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -14123,6 +14364,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -14331,6 +14573,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -14425,6 +14671,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -14442,6 +14692,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -14763,6 +15016,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -14950,6 +15207,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -15044,6 +15305,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -15197,6 +15462,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -15291,6 +15560,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -15308,6 +15581,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -15629,6 +15905,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -15783,6 +16063,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -16068,6 +16352,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -16080,6 +16365,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -16224,6 +16510,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -16318,6 +16608,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -16335,6 +16629,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -16648,6 +16945,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -16803,6 +17104,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -16815,6 +17117,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. diff --git a/docs/dyn/aiplatform_v1beta1.projects.locations.voices.html b/docs/dyn/aiplatform_v1beta1.projects.locations.voices.html new file mode 100644 index 0000000000..de0413a4ab --- /dev/null +++ b/docs/dyn/aiplatform_v1beta1.projects.locations.voices.html @@ -0,0 +1,488 @@ + + + +

Agent Platform API . projects . locations . voices

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Creates a custom voice from a natural-language prompt (`VOICE_TYPE_PROMPTED`) or from reference and consent audio recordings (`VOICE_TYPE_REPLICATED`).

+

+ delete(name, x__xgafv=None)

+

Deletes a custom stored voice (`store = true`) by resource name. Prebuilt catalog voices (`"prebuilt"`) cannot be deleted.

+

+ get(name, x__xgafv=None)

+

Gets a custom stored voice (`store = true`) by resource name. Prebuilt catalog voices (`VOICE_TYPE_PREBUILT`) cannot be retrieved via `GetVoice`; use `ListVoices` instead.

+

+ list(parent, accent=None, context=None, gender=None, languageCode=None, pageSize=None, pageToken=None, persona=None, pitch=None, regionCode=None, search=None, type=None, x__xgafv=None)

+

Lists custom stored voices owned by the caller as well as prebuilt system voices from Google's voice catalog.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, x__xgafv=None) +
Creates a custom voice from a natural-language prompt (`VOICE_TYPE_PROMPTED`) or from reference and consent audio recordings (`VOICE_TYPE_REPLICATED`).
+
+Args:
+  parent: string, Required. The parent resource where this voice will be created. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `VoicesService.CreateVoice`.
+  "store": True or False, # Optional. Whether the created voice is persisted and managed by Google. * When `true`, Google stores the voice and returns `Voice.id` (for example, `voice_abc123def456`), which can be managed via `GetVoice`, `ListVoices`, and `DeleteVoice` and referenced by ID in synthesis requests. Projects are subject to a maximum active stored voice quota; exceeding the quota returns `RESOURCE_EXHAUSTED`. * When `false` (default), the voice is not stored by Google and `Voice.key` (for example, `voicekey_...`) is returned for client-side storage and synthesis. Optional discovery metadata fields on `voice` are not persisted or returned when `store` is `false`. * Required to be `true` when `voice.type` is `"prompted"` (otherwise fails with `INVALID_ARGUMENT`).
+  "voice": { # A voice resource representing either a custom voice (created via `CreateVoice`) or a prebuilt system voice (returned by `ListVoices`). # Required. The voice to create. `voice.model` is optional; if omitted, the service selects the default voice creation model. Output-only fields on `Voice` (`id`, `key`, `expire_time`, `usage`) are ignored if set.
+    "accent": "A String", # Optional. Regional accent descriptor (e.g. "American", "British").
+    "context": "A String", # Optional. Optimal usage context or domain (e.g. "Conversational", "Audiobook", "News").
+    "description": "A String", # Optional. Descriptive summary of vocal timbre, personality, and tone.
+    "displayName": "A String", # Optional. User-provided display name for a stored voice (`store = true`), or the catalog name for a prebuilt voice.
+    "expireTime": "A String", # Output only. The timestamp at which a custom stored voice (`store = true`) or replicated voice key (`store = false`) expires. Unset for prebuilt catalog voices (`"prebuilt"`), which do not expire.
+    "gender": "A String", # Optional. Perceived voice gender presentation (e.g. "female", "male", "neutral").
+    "id": "A String", # Output only. The unique identifier of the voice. * For Google-managed custom voices (`store = true`), this is a generated ID with prefix `voice_` (for example, `voice_abc123def456`). Pass `voices/{id}` as the `name` in `GetVoice` and `DeleteVoice`, and pass `{id}` directly to `SpeechConfig.voice_config.voice` (or `SpeechConfig.voice`) during speech synthesis. * For prebuilt catalog voices (`"prebuilt"` returned by `ListVoices`), this is the speaker name (for example, `Puck` or `Charon`). * Unset when `CreateVoice` is called with `store = false`.
+    "key": "A String", # Output only. The client-managed voice replication key (with prefix `voicekey_`). Returned only by `CreateVoice` when `type` is `"replicated"` and `store` is `false`. Pass this key to `SpeechConfig.voice_config.voice` (or `SpeechConfig.voice`) during speech synthesis.
+    "languageCode": "A String", # Optional. Primary BCP-47 language tag (e.g. "en-US", "fr-FR").
+    "model": "A String", # Optional. The model used to design or replicate the voice. If omitted in `CreateVoice`, defaults to the latest supported voice design model. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for custom voices (`"prompted"` and `"replicated"`); unset for `"prebuilt"` voices. Created voices can be synthesized across any supported TTS synthesis model.
+    "persona": "A String", # Optional. Intended persona or character archetype (e.g. "Warm, Friendly", "Narrator").
+    "pitch": "A String", # Optional. Voice pitch classification.
+    "prompted": { # Parameters for prompted voice generation. Required in `CreateVoice` when `type` is `"prompted"`. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for prompted voices. # Parameters for prompted voice generation. Required in `CreateVoice` when `type` is `"prompted"`. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for prompted voices.
+      "input": "A String", # Required. The natural-language prompt describing the desired voice, e.g. "A deep, booming male voice of a massive evil ogre in his middle years."
+    },
+    "regionCode": "A String", # Optional. ISO 3166-1 alpha-2 or UN M.49 geographic region code (e.g. "US", "GB", "001").
+    "replicated": { # Input only. Parameters for replicated voice generation. Required on input when `type` is `"replicated"`. Not returned in responses. # Input only. Parameters for replicated voice generation. Required on input when `type` is `"replicated"`. Not returned in responses.
+      "consentAudio": { # Audio payload used for voice creation. # Required. Audio recording of the same speaker reading the required consent phrase, confirming authorization to replicate the voice.
+        "data": "A String", # Required. The raw audio bytes.
+        "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+      },
+      "sourceAudio": { # Audio payload used for voice creation. # Required. The reference audio sample of the speaker's voice to replicate. Must be an unmodified recording of an adult human voice.
+        "data": "A String", # Required. The raw audio bytes.
+        "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+      },
+    },
+    "sampleAudio": { # Audio payload used for voice creation. # Output only. Sample audio (synthesizer prompt audio) generated for a prompted voice. Populated only in `CreateVoice` and `GetVoice` responses when `type` is `"prompted"`; unset in `ListVoices` responses and for `"replicated"` or `"prebuilt"` voices.
+      "data": "A String", # Required. The raw audio bytes.
+      "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+    },
+    "type": "A String", # Required. The type of the voice. In `CreateVoice`, must be `"replicated"` or `"prompted"`. In `ListVoices` responses, may also be `"prebuilt"`.
+    "usage": { # Statistics on the interaction request's token usage. # Output only. Token usage statistics for the voice creation request. Populated only in the response of `CreateVoice` when `type` is `"prompted"`; unset for `"replicated"` and in `GetVoice` and `ListVoices` responses.
+      "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).
+    },
+  },
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A voice resource representing either a custom voice (created via `CreateVoice`) or a prebuilt system voice (returned by `ListVoices`).
+  "accent": "A String", # Optional. Regional accent descriptor (e.g. "American", "British").
+  "context": "A String", # Optional. Optimal usage context or domain (e.g. "Conversational", "Audiobook", "News").
+  "description": "A String", # Optional. Descriptive summary of vocal timbre, personality, and tone.
+  "displayName": "A String", # Optional. User-provided display name for a stored voice (`store = true`), or the catalog name for a prebuilt voice.
+  "expireTime": "A String", # Output only. The timestamp at which a custom stored voice (`store = true`) or replicated voice key (`store = false`) expires. Unset for prebuilt catalog voices (`"prebuilt"`), which do not expire.
+  "gender": "A String", # Optional. Perceived voice gender presentation (e.g. "female", "male", "neutral").
+  "id": "A String", # Output only. The unique identifier of the voice. * For Google-managed custom voices (`store = true`), this is a generated ID with prefix `voice_` (for example, `voice_abc123def456`). Pass `voices/{id}` as the `name` in `GetVoice` and `DeleteVoice`, and pass `{id}` directly to `SpeechConfig.voice_config.voice` (or `SpeechConfig.voice`) during speech synthesis. * For prebuilt catalog voices (`"prebuilt"` returned by `ListVoices`), this is the speaker name (for example, `Puck` or `Charon`). * Unset when `CreateVoice` is called with `store = false`.
+  "key": "A String", # Output only. The client-managed voice replication key (with prefix `voicekey_`). Returned only by `CreateVoice` when `type` is `"replicated"` and `store` is `false`. Pass this key to `SpeechConfig.voice_config.voice` (or `SpeechConfig.voice`) during speech synthesis.
+  "languageCode": "A String", # Optional. Primary BCP-47 language tag (e.g. "en-US", "fr-FR").
+  "model": "A String", # Optional. The model used to design or replicate the voice. If omitted in `CreateVoice`, defaults to the latest supported voice design model. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for custom voices (`"prompted"` and `"replicated"`); unset for `"prebuilt"` voices. Created voices can be synthesized across any supported TTS synthesis model.
+  "persona": "A String", # Optional. Intended persona or character archetype (e.g. "Warm, Friendly", "Narrator").
+  "pitch": "A String", # Optional. Voice pitch classification.
+  "prompted": { # Parameters for prompted voice generation. Required in `CreateVoice` when `type` is `"prompted"`. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for prompted voices. # Parameters for prompted voice generation. Required in `CreateVoice` when `type` is `"prompted"`. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for prompted voices.
+    "input": "A String", # Required. The natural-language prompt describing the desired voice, e.g. "A deep, booming male voice of a massive evil ogre in his middle years."
+  },
+  "regionCode": "A String", # Optional. ISO 3166-1 alpha-2 or UN M.49 geographic region code (e.g. "US", "GB", "001").
+  "replicated": { # Input only. Parameters for replicated voice generation. Required on input when `type` is `"replicated"`. Not returned in responses. # Input only. Parameters for replicated voice generation. Required on input when `type` is `"replicated"`. Not returned in responses.
+    "consentAudio": { # Audio payload used for voice creation. # Required. Audio recording of the same speaker reading the required consent phrase, confirming authorization to replicate the voice.
+      "data": "A String", # Required. The raw audio bytes.
+      "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+    },
+    "sourceAudio": { # Audio payload used for voice creation. # Required. The reference audio sample of the speaker's voice to replicate. Must be an unmodified recording of an adult human voice.
+      "data": "A String", # Required. The raw audio bytes.
+      "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+    },
+  },
+  "sampleAudio": { # Audio payload used for voice creation. # Output only. Sample audio (synthesizer prompt audio) generated for a prompted voice. Populated only in `CreateVoice` and `GetVoice` responses when `type` is `"prompted"`; unset in `ListVoices` responses and for `"replicated"` or `"prebuilt"` voices.
+    "data": "A String", # Required. The raw audio bytes.
+    "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+  },
+  "type": "A String", # Required. The type of the voice. In `CreateVoice`, must be `"replicated"` or `"prompted"`. In `ListVoices` responses, may also be `"prebuilt"`.
+  "usage": { # Statistics on the interaction request's token usage. # Output only. Token usage statistics for the voice creation request. Populated only in the response of `CreateVoice` when `type` is `"prompted"`; unset for `"replicated"` and in `GetVoice` and `ListVoices` responses.
+    "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 a custom stored voice (`store = true`) by resource name. Prebuilt catalog voices (`"prebuilt"`) cannot be deleted.
+
+Args:
+  name: string, Required. The resource name of the custom stored voice to delete (for example, `voices/voice_abc123def456`). (required)
+  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 `VoicesService.DeleteVoice`.
+}
+
+ +
+ get(name, x__xgafv=None) +
Gets a custom stored voice (`store = true`) by resource name. Prebuilt catalog voices (`VOICE_TYPE_PREBUILT`) cannot be retrieved via `GetVoice`; use `ListVoices` instead.
+
+Args:
+  name: string, Required. The resource name of the custom stored voice to retrieve (for example, `voices/voice_abc123def456`). (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # A voice resource representing either a custom voice (created via `CreateVoice`) or a prebuilt system voice (returned by `ListVoices`).
+  "accent": "A String", # Optional. Regional accent descriptor (e.g. "American", "British").
+  "context": "A String", # Optional. Optimal usage context or domain (e.g. "Conversational", "Audiobook", "News").
+  "description": "A String", # Optional. Descriptive summary of vocal timbre, personality, and tone.
+  "displayName": "A String", # Optional. User-provided display name for a stored voice (`store = true`), or the catalog name for a prebuilt voice.
+  "expireTime": "A String", # Output only. The timestamp at which a custom stored voice (`store = true`) or replicated voice key (`store = false`) expires. Unset for prebuilt catalog voices (`"prebuilt"`), which do not expire.
+  "gender": "A String", # Optional. Perceived voice gender presentation (e.g. "female", "male", "neutral").
+  "id": "A String", # Output only. The unique identifier of the voice. * For Google-managed custom voices (`store = true`), this is a generated ID with prefix `voice_` (for example, `voice_abc123def456`). Pass `voices/{id}` as the `name` in `GetVoice` and `DeleteVoice`, and pass `{id}` directly to `SpeechConfig.voice_config.voice` (or `SpeechConfig.voice`) during speech synthesis. * For prebuilt catalog voices (`"prebuilt"` returned by `ListVoices`), this is the speaker name (for example, `Puck` or `Charon`). * Unset when `CreateVoice` is called with `store = false`.
+  "key": "A String", # Output only. The client-managed voice replication key (with prefix `voicekey_`). Returned only by `CreateVoice` when `type` is `"replicated"` and `store` is `false`. Pass this key to `SpeechConfig.voice_config.voice` (or `SpeechConfig.voice`) during speech synthesis.
+  "languageCode": "A String", # Optional. Primary BCP-47 language tag (e.g. "en-US", "fr-FR").
+  "model": "A String", # Optional. The model used to design or replicate the voice. If omitted in `CreateVoice`, defaults to the latest supported voice design model. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for custom voices (`"prompted"` and `"replicated"`); unset for `"prebuilt"` voices. Created voices can be synthesized across any supported TTS synthesis model.
+  "persona": "A String", # Optional. Intended persona or character archetype (e.g. "Warm, Friendly", "Narrator").
+  "pitch": "A String", # Optional. Voice pitch classification.
+  "prompted": { # Parameters for prompted voice generation. Required in `CreateVoice` when `type` is `"prompted"`. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for prompted voices. # Parameters for prompted voice generation. Required in `CreateVoice` when `type` is `"prompted"`. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for prompted voices.
+    "input": "A String", # Required. The natural-language prompt describing the desired voice, e.g. "A deep, booming male voice of a massive evil ogre in his middle years."
+  },
+  "regionCode": "A String", # Optional. ISO 3166-1 alpha-2 or UN M.49 geographic region code (e.g. "US", "GB", "001").
+  "replicated": { # Input only. Parameters for replicated voice generation. Required on input when `type` is `"replicated"`. Not returned in responses. # Input only. Parameters for replicated voice generation. Required on input when `type` is `"replicated"`. Not returned in responses.
+    "consentAudio": { # Audio payload used for voice creation. # Required. Audio recording of the same speaker reading the required consent phrase, confirming authorization to replicate the voice.
+      "data": "A String", # Required. The raw audio bytes.
+      "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+    },
+    "sourceAudio": { # Audio payload used for voice creation. # Required. The reference audio sample of the speaker's voice to replicate. Must be an unmodified recording of an adult human voice.
+      "data": "A String", # Required. The raw audio bytes.
+      "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+    },
+  },
+  "sampleAudio": { # Audio payload used for voice creation. # Output only. Sample audio (synthesizer prompt audio) generated for a prompted voice. Populated only in `CreateVoice` and `GetVoice` responses when `type` is `"prompted"`; unset in `ListVoices` responses and for `"replicated"` or `"prebuilt"` voices.
+    "data": "A String", # Required. The raw audio bytes.
+    "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+  },
+  "type": "A String", # Required. The type of the voice. In `CreateVoice`, must be `"replicated"` or `"prompted"`. In `ListVoices` responses, may also be `"prebuilt"`.
+  "usage": { # Statistics on the interaction request's token usage. # Output only. Token usage statistics for the voice creation request. Populated only in the response of `CreateVoice` when `type` is `"prompted"`; unset for `"replicated"` and in `GetVoice` and `ListVoices` responses.
+    "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).
+  },
+}
+
+ +
+ list(parent, accent=None, context=None, gender=None, languageCode=None, pageSize=None, pageToken=None, persona=None, pitch=None, regionCode=None, search=None, type=None, x__xgafv=None) +
Lists custom stored voices owned by the caller as well as prebuilt system voices from Google's voice catalog.
+
+Args:
+  parent: string, Required. The parent that owns this collection of voices. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API. (required)
+  accent: string, Optional. Filter by accent description (e.g. "American", "British"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified accents (OR). (repeated)
+  context: string, Optional. Filter by intended context or domain (e.g. "News, Commercial"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified contexts (OR). (repeated)
+  gender: string, Optional. Filter by gender presentation (e.g. "female", "male", "neutral"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified genders (OR). (repeated)
+  languageCode: string, Optional. Filter by BCP-47 language code (e.g. "en-US"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified language codes (OR). (repeated)
+  pageSize: integer, Optional. The maximum number of voices to return per page. The service may return fewer than this value. If unspecified, at most 50 voices are returned. The maximum value is 1000; values above 1000 are coerced to 1000.
+  pageToken: string, A page token, received from a previous `ListVoices` call. Provide this to retrieve the subsequent page. When paginating, all filter query parameters (`language_code`, `region_code`, `accent`, `persona`, `context`, `gender`, `pitch`, `type`, and `search`) must match the call that returned this token; otherwise the request fails with `INVALID_ARGUMENT`. `page_size` may change between pages.
+  persona: string, Optional. Filter by vocal persona (e.g. "Warm, Friendly"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified personas (OR). (repeated)
+  pitch: string, Optional. Filter by vocal pitch. Accepts `"low"`, `"medium"`, `"high"` (case-insensitive). If multiple values are specified, matches voices with any of the specified pitches (OR). (repeated)
+  regionCode: string, Optional. Filter by ISO 3166-1 alpha-2 or UN M.49 region code (e.g. "US", "001"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified region codes (OR). (repeated)
+  search: string, Optional. Free-text substring search query matched case-insensitively against both `display_name` and `description`. Maximum 2048 bytes.
+  type: string, Optional. Filter by voice type. Accepts `"prebuilt"`, `"replicated"`, `"prompted"` (case-insensitive). If multiple values are specified, matches voices with any of the specified types (OR). (repeated)
+  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 `VoicesService.ListVoices`.
+  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If empty, there are no subsequent pages.
+  "voices": [ # The voices from the specified collection.
+    { # A voice resource representing either a custom voice (created via `CreateVoice`) or a prebuilt system voice (returned by `ListVoices`).
+      "accent": "A String", # Optional. Regional accent descriptor (e.g. "American", "British").
+      "context": "A String", # Optional. Optimal usage context or domain (e.g. "Conversational", "Audiobook", "News").
+      "description": "A String", # Optional. Descriptive summary of vocal timbre, personality, and tone.
+      "displayName": "A String", # Optional. User-provided display name for a stored voice (`store = true`), or the catalog name for a prebuilt voice.
+      "expireTime": "A String", # Output only. The timestamp at which a custom stored voice (`store = true`) or replicated voice key (`store = false`) expires. Unset for prebuilt catalog voices (`"prebuilt"`), which do not expire.
+      "gender": "A String", # Optional. Perceived voice gender presentation (e.g. "female", "male", "neutral").
+      "id": "A String", # Output only. The unique identifier of the voice. * For Google-managed custom voices (`store = true`), this is a generated ID with prefix `voice_` (for example, `voice_abc123def456`). Pass `voices/{id}` as the `name` in `GetVoice` and `DeleteVoice`, and pass `{id}` directly to `SpeechConfig.voice_config.voice` (or `SpeechConfig.voice`) during speech synthesis. * For prebuilt catalog voices (`"prebuilt"` returned by `ListVoices`), this is the speaker name (for example, `Puck` or `Charon`). * Unset when `CreateVoice` is called with `store = false`.
+      "key": "A String", # Output only. The client-managed voice replication key (with prefix `voicekey_`). Returned only by `CreateVoice` when `type` is `"replicated"` and `store` is `false`. Pass this key to `SpeechConfig.voice_config.voice` (or `SpeechConfig.voice`) during speech synthesis.
+      "languageCode": "A String", # Optional. Primary BCP-47 language tag (e.g. "en-US", "fr-FR").
+      "model": "A String", # Optional. The model used to design or replicate the voice. If omitted in `CreateVoice`, defaults to the latest supported voice design model. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for custom voices (`"prompted"` and `"replicated"`); unset for `"prebuilt"` voices. Created voices can be synthesized across any supported TTS synthesis model.
+      "persona": "A String", # Optional. Intended persona or character archetype (e.g. "Warm, Friendly", "Narrator").
+      "pitch": "A String", # Optional. Voice pitch classification.
+      "prompted": { # Parameters for prompted voice generation. Required in `CreateVoice` when `type` is `"prompted"`. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for prompted voices. # Parameters for prompted voice generation. Required in `CreateVoice` when `type` is `"prompted"`. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for prompted voices.
+        "input": "A String", # Required. The natural-language prompt describing the desired voice, e.g. "A deep, booming male voice of a massive evil ogre in his middle years."
+      },
+      "regionCode": "A String", # Optional. ISO 3166-1 alpha-2 or UN M.49 geographic region code (e.g. "US", "GB", "001").
+      "replicated": { # Input only. Parameters for replicated voice generation. Required on input when `type` is `"replicated"`. Not returned in responses. # Input only. Parameters for replicated voice generation. Required on input when `type` is `"replicated"`. Not returned in responses.
+        "consentAudio": { # Audio payload used for voice creation. # Required. Audio recording of the same speaker reading the required consent phrase, confirming authorization to replicate the voice.
+          "data": "A String", # Required. The raw audio bytes.
+          "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+        },
+        "sourceAudio": { # Audio payload used for voice creation. # Required. The reference audio sample of the speaker's voice to replicate. Must be an unmodified recording of an adult human voice.
+          "data": "A String", # Required. The raw audio bytes.
+          "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+        },
+      },
+      "sampleAudio": { # Audio payload used for voice creation. # Output only. Sample audio (synthesizer prompt audio) generated for a prompted voice. Populated only in `CreateVoice` and `GetVoice` responses when `type` is `"prompted"`; unset in `ListVoices` responses and for `"replicated"` or `"prebuilt"` voices.
+        "data": "A String", # Required. The raw audio bytes.
+        "mimeType": "A String", # Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).
+      },
+      "type": "A String", # Required. The type of the voice. In `CreateVoice`, must be `"replicated"` or `"prompted"`. In `ListVoices` responses, may also be `"prebuilt"`.
+      "usage": { # Statistics on the interaction request's token usage. # Output only. Token usage statistics for the voice creation request. Populated only in the response of `CreateVoice` when `type` is `"prompted"`; unset for `"replicated"` and in `GetVoice` and `ListVoices` responses.
+        "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).
+      },
+    },
+  ],
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/aiplatform_v1beta1.publishers.models.html b/docs/dyn/aiplatform_v1beta1.publishers.models.html index 4f922c816d..4dffefda03 100644 --- a/docs/dyn/aiplatform_v1beta1.publishers.models.html +++ b/docs/dyn/aiplatform_v1beta1.publishers.models.html @@ -202,6 +202,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -333,6 +337,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -484,6 +492,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -496,6 +505,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -596,6 +606,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -613,6 +627,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1001,6 +1018,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1152,6 +1173,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -1164,6 +1186,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1274,6 +1297,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1307,6 +1334,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1649,6 +1679,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3273,6 +3307,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3424,6 +3462,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3436,6 +3475,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3546,6 +3586,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3579,6 +3623,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3921,6 +3968,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html index 3906dc467f..c4e5dad926 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.html @@ -335,6 +335,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -818,6 +822,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1196,6 +1204,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1579,6 +1591,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html index 5200e8d4f2..a58c092d45 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.memories.html @@ -342,6 +342,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -389,6 +393,7 @@

Method Details

"scope": { # Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'. "a_key": "A String", }, + "timeZone": "A String", # Optional. The time zone of the conversation or caller, used as the baseline for resolving relative time expressions (e.g., "yesterday") and formatting timestamps. If not set, "UTC" is used. Must be a valid IANA Time Zone Database name, e.g. "America/New_York". "vertexSessionSource": { # Defines an Agent Engine Session from which to generate the memories. If `scope` is not provided, the scope will be extracted from the Session (i.e. {"user_id": sesison.user_id}). # Defines a Vertex Session as the source content from which to generate memories. "endTime": "A String", # Optional. End time (exclusive) of the time range. If not set, the end time is unbounded. "session": "A String", # Required. The resource name of the Session to generate memories for. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sessions/{session}` @@ -573,6 +578,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html index 42890ce61f..413833b319 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sandboxEnvironmentTemplates.html @@ -177,6 +177,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "persistentDiskConfig": { # Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. A persistent disk provides durable, per-sandbox block storage whose contents survive across the sandbox lifecycle events that this service supports (e.g. pause/resume), unlike ephemeral local storage which is lost when the underlying runtime is torn down. # Optional. Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. When unset (or when `enabled` is `false`), sandboxes created from this template are not backed by a persistent disk and rely on ephemeral storage only. See PersistentDiskConfig for details. "enabled": True or False, # Optional. Whether a persistent disk is attached to sandboxes created from this template. Defaults to `false`. This flag lets a template carry (and preserve) disk configuration while keeping the disk detached, so it can be toggled on later without re-specifying the rest of the config. When `false`, the remaining fields in this message are ignored. + "mountPath": "A String", # Optional. The absolute path inside the sandbox container at which the persistent disk is mounted. Defaults to `/workspace` when unset. Ignored when `enabled` is `false`. Only writes beneath this path land on the disk. Writes elsewhere go to the container's writable layer, which counts against the container's ephemeral storage and is lost when the sandbox's runtime is torn down, so this should be the directory the workload actually writes to. Paths that would shadow the container's system directories (for example `/etc`, `/proc`, or `/usr` itself) are rejected. "sizeGb": "A String", # Optional. The size of the persistent disk in GB. Must be non-negative. When `enabled` is `true`, a positive value is required; when unset or zero while enabled, the service applies a default size. Ignored when `enabled` is `false`. }, "state": "A String", # Output only. The state of the sandbox environment template. @@ -327,6 +328,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "persistentDiskConfig": { # Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. A persistent disk provides durable, per-sandbox block storage whose contents survive across the sandbox lifecycle events that this service supports (e.g. pause/resume), unlike ephemeral local storage which is lost when the underlying runtime is torn down. # Optional. Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. When unset (or when `enabled` is `false`), sandboxes created from this template are not backed by a persistent disk and rely on ephemeral storage only. See PersistentDiskConfig for details. "enabled": True or False, # Optional. Whether a persistent disk is attached to sandboxes created from this template. Defaults to `false`. This flag lets a template carry (and preserve) disk configuration while keeping the disk detached, so it can be toggled on later without re-specifying the rest of the config. When `false`, the remaining fields in this message are ignored. + "mountPath": "A String", # Optional. The absolute path inside the sandbox container at which the persistent disk is mounted. Defaults to `/workspace` when unset. Ignored when `enabled` is `false`. Only writes beneath this path land on the disk. Writes elsewhere go to the container's writable layer, which counts against the container's ephemeral storage and is lost when the sandbox's runtime is torn down, so this should be the directory the workload actually writes to. Paths that would shadow the container's system directories (for example `/etc`, `/proc`, or `/usr` itself) are rejected. "sizeGb": "A String", # Optional. The size of the persistent disk in GB. Must be non-negative. When `enabled` is `true`, a positive value is required; when unset or zero while enabled, the service applies a default size. Ignored when `enabled` is `false`. }, "state": "A String", # Output only. The state of the sandbox environment template. @@ -420,6 +422,7 @@

Method Details

"name": "A String", # Identifier. The resource name of the SandboxEnvironmentTemplate. Format: `projects/{project}/locations/{location}/reasoningEngines/{reasoning_engine}/sandboxEnvironmentTemplates/{sandbox_environment_template}` "persistentDiskConfig": { # Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. A persistent disk provides durable, per-sandbox block storage whose contents survive across the sandbox lifecycle events that this service supports (e.g. pause/resume), unlike ephemeral local storage which is lost when the underlying runtime is torn down. # Optional. Configuration for attaching a persistent disk (PD) to each SandboxEnvironment created from this template. When unset (or when `enabled` is `false`), sandboxes created from this template are not backed by a persistent disk and rely on ephemeral storage only. See PersistentDiskConfig for details. "enabled": True or False, # Optional. Whether a persistent disk is attached to sandboxes created from this template. Defaults to `false`. This flag lets a template carry (and preserve) disk configuration while keeping the disk detached, so it can be toggled on later without re-specifying the rest of the config. When `false`, the remaining fields in this message are ignored. + "mountPath": "A String", # Optional. The absolute path inside the sandbox container at which the persistent disk is mounted. Defaults to `/workspace` when unset. Ignored when `enabled` is `false`. Only writes beneath this path land on the disk. Writes elsewhere go to the container's writable layer, which counts against the container's ephemeral storage and is lost when the sandbox's runtime is torn down, so this should be the directory the workload actually writes to. Paths that would shadow the container's system directories (for example `/etc`, `/proc`, or `/usr` itself) are rejected. "sizeGb": "A String", # Optional. The size of the persistent disk in GB. Must be non-negative. When `enabled` is `true`, a positive value is required; when unset or zero while enabled, the service applies a default size. Ignored when `enabled` is `false`. }, "state": "A String", # Output only. The state of the sandbox environment template. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html index 2dcd483071..989946d177 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.events.html @@ -204,6 +204,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html index 91f8c47c5b..a29a9cebdc 100644 --- a/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html +++ b/docs/dyn/aiplatform_v1beta1.reasoningEngines.sessions.html @@ -212,6 +212,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. diff --git a/docs/dyn/aiplatform_v1beta1.v1beta1.html b/docs/dyn/aiplatform_v1beta1.v1beta1.html index 7db638bbd6..d8241afb26 100644 --- a/docs/dyn/aiplatform_v1beta1.v1beta1.html +++ b/docs/dyn/aiplatform_v1beta1.v1beta1.html @@ -242,6 +242,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -254,6 +255,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -450,6 +452,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -462,6 +465,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -637,6 +641,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -649,6 +654,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -905,6 +911,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -917,6 +924,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -1091,6 +1099,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1116,6 +1128,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1439,6 +1454,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1464,6 +1483,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -1783,6 +1805,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1879,6 +1905,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -1899,6 +1929,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2144,6 +2177,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2457,6 +2493,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -2495,6 +2535,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -2740,6 +2783,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -3053,6 +3099,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3165,6 +3215,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3264,6 +3318,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3361,6 +3419,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3458,6 +3520,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -3660,6 +3726,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3672,6 +3739,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -3847,6 +3915,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -3859,6 +3928,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4096,6 +4166,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4108,6 +4179,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4283,6 +4355,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -4295,6 +4368,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. @@ -4461,6 +4535,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -4599,6 +4677,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5252,6 +5334,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5277,6 +5363,9 @@

Method Details

"codeExecution": { # Tool that executes code generated by the model, and automatically returns the result to the model. See also ExecutableCode and CodeExecutionResult, which are input and output to this tool. # Optional. CodeExecution tool type. Enables the model to execute code as part of generation. }, "computerUse": { # Tool to support computer use. # Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations. + "disabledSafetyPolicies": [ # Optional. Disabled safety policies for computer use. + "A String", + ], "enablePromptInjectionDetection": True or False, # Optional. Enables the prompt injection detection check on computer-use request. "environment": "A String", # Required. The environment being operated. "excludedPredefinedFunctions": [ # Optional. By default, [predefined functions](https://cloud.google.com/vertex-ai/generative-ai/docs/computer-use#supported-actions) are included in the final model call. Some of them can be explicitly excluded from being automatically included. This can serve two purposes: 1. Using a more restricted / different action space. 2. Improving the definitions / instructions of predefined functions. @@ -5593,6 +5682,10 @@

Method Details

"mediaResolution": { # per part media resolution. Media resolution for the input media. # per part media resolution. Media resolution for the input media. "level": "A String", # The tokenization quality used for given media. }, + "speechMetadata": { # Structured Metadata Sub-Message for Part # Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part. + "speaker": "A String", # Optional. Identifies which speaker is speaking this turn. + "style": "A String", # Optional. Natural language description of the vocal style (e.g., "cheerful"). + }, "text": "A String", # Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent. "thought": True or False, # Optional. Indicates whether the `part` represents the model's thought process or reasoning. "thoughtSignature": "A String", # Optional. An opaque signature for the thought so it can be reused in subsequent requests. @@ -5756,6 +5849,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, ], @@ -5768,6 +5862,7 @@

Method Details

"mimeType": "A String", # Optional. The mimetype of the voice sample. The only currently supported value is `audio/wav`. This represents 16-bit signed little-endian wav data, with a 24kHz sampling rate. `mime_type` will default to `audio/wav` if not set. "voiceSampleAudio": "A String", # Optional. The sample of the custom voice. }, + "voice": "A String", # Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`). }, }, "stopSequences": [ # Optional. A list of character sequences that will stop the model from generating further tokens. If a stop sequence is generated, the output will end at that point. This is useful for controlling the length and structure of the output. For example, you can use ["\n", "###"] to stop generation at a new line or a specific marker. diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1.json index e0c6367110..94d92b840a 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1.json @@ -256,6 +256,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://aiplatform.eu.rep.googleapis.com/", "location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://aiplatform-preprod.us.rep.googleapis.com/", +"location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -6939,6 +6944,12 @@ "pattern": "^projects/[^/]+/cacheConfig$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields of `cache_config` to update. Supported paths are `disable_cache`, `retention_config` (and its subfields such as `retention_config.retention_type`), and the special value `*`; any other path returns `INVALID_ARGUMENT`. Fields not covered by the mask keep their stored value. If the mask is omitted, it is treated as an implied mask covering the fields populated in `cache_config`, so updating one field never clears another. `retention_config` is covered only when the request carries it. `disable_cache` is always covered: it is a bare `bool`, so the server cannot tell a request that omits it from one that sets it to `false`. `*` requests full replacement of the resource: every settable field is written from the request, clearing `retention_config` when the request omits it. It cannot be combined with other paths. Prefer naming fields explicitly -- a caller that sends `*` without knowing about a field added to `CacheConfig` later would silently reset that field.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "v1/{+name}", @@ -7518,6 +7529,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7548,6 +7560,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7573,6 +7586,7 @@ "$ref": "GoogleCloudAiplatformV1Agent" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7650,6 +7664,7 @@ "$ref": "GoogleCloudAiplatformV1ListAgentsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -7684,6 +7699,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -36834,7 +36850,7 @@ } } }, -"revision": "20260920", +"revision": "20260930", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionExperimentsResponse": { @@ -36853,12 +36869,8 @@ "id": "CloudAiLargeModelsVisionExperimentsResponseProEditResult", "properties": { "structuredPrompt": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "The output structured prompt produced by this edit.", -"type": "object" +"description": "The output structured prompt (JSON string) produced by this edit.", +"type": "string" } }, "type": "object" @@ -37121,12 +37133,8 @@ "type": "string" }, "structuredPrompt": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "A JSON object containing the user's modified URF. The URF Editing Preamble will diff this against the original URF to determine what changed.", -"type": "object" +"description": "A JSON string containing the user's modified URF. The URF Editing Preamble will diff this against the original URF to determine what changed.", +"type": "string" } }, "type": "object" @@ -38043,7 +38051,7 @@ "type": "object" }, "GoogleCloudAiplatformV1AgentTool": { -"description": "A tool provides a list of actions available to the Agent during the process of executing a task.", +"description": "A tool provides a list of actions available to the Agent during the process of executing a task. Example JSON for an MCP server tool: { \"type\": \"mcp_server\", \"name\": \"my-mcp-server\", \"url\": \"https://api.example.com/mcp\", \"headers\": { \"Authorization\": \"Bearer token123\" } }", "id": "GoogleCloudAiplatformV1AgentTool", "properties": { "headers": { @@ -38062,7 +38070,7 @@ "type": "string" }, "url": { -"description": "Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation.", +"description": "Optional. Fallback for the tool's runtime reference, consumed by `CreateAgent` to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`, and optional: the Agent service derives the runtime reference from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), and reads this only when that lookup yields none.", "type": "string" } }, @@ -39801,6 +39809,31 @@ "name": { "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", "type": "string" +}, +"retentionConfig": { +"$ref": "GoogleCloudAiplatformV1CacheConfigRetentionConfig", +"description": "Optional. Project-level retention type for implicit caching. On `GetCacheConfig` this is populated with the retention the project gets: a project that has stated no preference reports `DURABLE`. On `UpdateCacheConfig`, leaving it unset means the project states no preference. Whether that clears an existing preference depends on `update_mask`; see that field." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1CacheConfigRetentionConfig": { +"description": "Configures the retention behavior of GenAI implicit (automatic) context caching for this project.", +"id": "GoogleCloudAiplatformV1CacheConfigRetentionConfig", +"properties": { +"retentionType": { +"description": "Optional. Retention type applied to implicit cache traffic for this project.", +"enum": [ +"RETENTION_TYPE_UNSPECIFIED", +"EPHEMERAL", +"DURABLE" +], +"enumDescriptions": [ +"Unspecified. Treated the same as `DURABLE`.", +"Restricts implicit caching to ephemeral, volatile-memory-backed retention only.", +"Allows implicit caching to use long-lived, durable-storage-backed retention." +], +"type": "string" } }, "type": "object" @@ -49015,6 +49048,10 @@ "description": "Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'.", "type": "object" }, +"timeZone": { +"description": "Optional. The time zone of the conversation or caller, used as the baseline for resolving relative time expressions (e.g., \"yesterday\") and formatting timestamps. If not set, \"UTC\" is used. Must be a valid IANA Time Zone Database name, e.g. \"America/New_York\".", +"type": "string" +}, "vertexSessionSource": { "$ref": "GoogleCloudAiplatformV1GenerateMemoriesRequestVertexSessionSource", "description": "Defines a Vertex Session as the source content from which to generate memories." @@ -57472,6 +57509,10 @@ false "$ref": "GoogleCloudAiplatformV1PartMediaResolution", "description": "per part media resolution. Media resolution for the input media." }, +"speechMetadata": { +"$ref": "GoogleCloudAiplatformV1SpeechMetadata", +"description": "Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part." +}, "text": { "description": "Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.", "type": "string" @@ -67748,6 +67789,10 @@ false "description": "Optional. The user-defined name of the SemanticGovernancePolicy.", "type": "string" }, +"dryRun": { +"description": "Optional. If true, this policy is evaluated and its result is reported, but the policy is not enforced: a violation does not block the agent's action. Use this to validate a policy against real traffic before turning enforcement on. Defaults to `false`, meaning the policy is enforced. This setting applies only to this policy. If the SemanticGovernancePolicyEngine for the project is itself in dry run, every policy behaves as dry run regardless of this field.", +"type": "boolean" +}, "etag": { "description": "Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned.", "type": "string" @@ -68308,6 +68353,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1SpeechMetadata": { +"description": "Structured Metadata Sub-Message for Part", +"id": "GoogleCloudAiplatformV1SpeechMetadata", +"properties": { +"speaker": { +"description": "Optional. Identifies which speaker is speaking this turn.", +"type": "string" +}, +"style": { +"description": "Optional. Natural language description of the vocal style (e.g., \"cheerful\").", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata": { "description": "Metadata information for NotebookService.StartNotebookRuntime.", "id": "GoogleCloudAiplatformV1StartNotebookRuntimeOperationMetadata", @@ -70376,6 +70436,33 @@ false "description": "Tool to support computer use.", "id": "GoogleCloudAiplatformV1ToolComputerUse", "properties": { +"disabledSafetyPolicies": { +"description": "Optional. Disabled safety policies for computer use.", +"items": { +"enum": [ +"SAFETY_POLICY_UNSPECIFIED", +"FINANCIAL_TRANSACTIONS", +"SENSITIVE_DATA_MODIFICATION", +"COMMUNICATION_TOOL", +"ACCOUNT_CREATION", +"DATA_MODIFICATION", +"USER_CONSENT_MANAGEMENT", +"LEGAL_TERMS_AND_AGREEMENTS" +], +"enumDescriptions": [ +"Unspecified safety policy. This value should not be used.", +"Financial transactions safety policy.", +"Sensitive data modification safety policy.", +"Communication tool safety policy.", +"Account creation safety policy.", +"Data modification safety policy.", +"User consent management safety policy.", +"Legal terms and agreements safety policy." +], +"type": "string" +}, +"type": "array" +}, "enablePromptInjectionDetection": { "description": "Optional. Enables the prompt injection detection check on computer-use request.", "type": "boolean" @@ -71571,6 +71658,11 @@ false "readOnly": true, "type": "string" }, +"gcsMetricsUri": { +"description": "Output only. The Cloud Storage metrics URI associated with this TuningJob.", +"readOnly": true, +"type": "string" +}, "labels": { "additionalProperties": { "type": "string" @@ -72499,6 +72591,10 @@ false "replicatedVoiceConfig": { "$ref": "GoogleCloudAiplatformV1ReplicatedVoiceConfig", "description": "Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample." +}, +"voice": { +"description": "Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`).", +"type": "string" } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json index fc1d4a2574..a208dff18e 100644 --- a/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/aiplatform.v1beta1.json @@ -256,6 +256,11 @@ "description": "Regional Endpoint", "endpointUrl": "https://aiplatform.eu.rep.googleapis.com/", "location": "eu" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://aiplatform-preprod.us.rep.googleapis.com/", +"location": "us" } ], "fullyEncodeReservedExpansion": true, @@ -9456,6 +9461,12 @@ "pattern": "^projects/[^/]+/cacheConfig$", "required": true, "type": "string" +}, +"updateMask": { +"description": "Optional. The list of fields of `cache_config` to update. Supported paths are `disable_cache`, `retention_config` (and its subfields such as `retention_config.retention_type`), and the special value `*`; any other path returns `INVALID_ARGUMENT`. Fields not covered by the mask keep their stored value. If the mask is omitted, it is treated as an implied mask covering the fields populated in `cache_config`, so updating one field never clears another. `retention_config` is covered only when the request carries it. `disable_cache` is always covered: it is a bare `bool`, so the server cannot tell a request that omits it from one that sets it to `false`. `*` requests full replacement of the resource: every settable field is written from the request, clearing `retention_config` when the request omits it. It cannot be combined with other paths. Prefer naming fields explicitly -- a caller that sends `*` without knowing about a field added to `CacheConfig` later would silently reset that field.", +"format": "google-fieldmask", +"location": "query", +"type": "string" } }, "path": "v1beta1/{+name}", @@ -10217,6 +10228,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10247,6 +10259,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10272,6 +10285,7 @@ "$ref": "GoogleCloudAiplatformV1beta1Agent" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10349,6 +10363,7 @@ "$ref": "GoogleCloudAiplatformV1beta1ListAgentsResponse" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -10383,6 +10398,7 @@ "$ref": "GoogleLongrunningOperation" }, "scopes": [ +"https://www.googleapis.com/auth/aiplatform", "https://www.googleapis.com/auth/cloud-platform" ] }, @@ -40314,7 +40330,7 @@ ], "parameters": { "a2aTaskRecordId": { -"description": "Optional. The user defined ID to use for the A2ATaskRecord, which will become the final component of the A2ATaskRecord resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first character must be a letter, and the last character must be a letter or number.", +"description": "Optional. The user defined ID to use for the A2ATaskRecord, which will become the final component of the A2ATaskRecord resource name. If not provided, Vertex AI will generate a value for this ID. This value may be up to 63 characters, and valid characters are `[a-z0-9-]`. The first and last characters must be a letter or number. This accepts A2A task IDs such as UUIDs, which may start with a digit.", "location": "query", "type": "string" }, @@ -42976,6 +42992,177 @@ } } } +}, +"voices": { +"methods": { +"create": { +"description": "Creates a custom voice from a natural-language prompt (`VOICE_TYPE_PROMPTED`) or from reference and consent audio recordings (`VOICE_TYPE_REPLICATED`).", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/voices:create", +"httpMethod": "POST", +"id": "aiplatform.projects.locations.voices.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The parent resource where this voice will be created. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/voices:create", +"request": { +"$ref": "GoogleLearningVertexApiInteractionsV1beta1CreateVoiceRequest" +}, +"response": { +"$ref": "GenaiVertexV1beta1Voice" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"delete": { +"description": "Deletes a custom stored voice (`store = true`) by resource name. Prebuilt catalog voices (`\"prebuilt\"`) cannot be deleted.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/voices/{voicesId}:delete", +"httpMethod": "DELETE", +"id": "aiplatform.projects.locations.voices.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the custom stored voice to delete (for example, `voices/voice_abc123def456`).", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/voices/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:delete", +"response": { +"$ref": "GoogleLearningVertexApiInteractionsV1beta1DeleteVoiceResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"get": { +"description": "Gets a custom stored voice (`store = true`) by resource name. Prebuilt catalog voices (`VOICE_TYPE_PREBUILT`) cannot be retrieved via `GetVoice`; use `ListVoices` instead.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/voices/{voicesId}:get", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.voices.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The resource name of the custom stored voice to retrieve (for example, `voices/voice_abc123def456`).", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/voices/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1beta1/{+name}:get", +"response": { +"$ref": "GenaiVertexV1beta1Voice" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"list": { +"description": "Lists custom stored voices owned by the caller as well as prebuilt system voices from Google's voice catalog.", +"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/voices:list", +"httpMethod": "GET", +"id": "aiplatform.projects.locations.voices.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"accent": { +"description": "Optional. Filter by accent description (e.g. \"American\", \"British\"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified accents (OR).", +"location": "query", +"repeated": true, +"type": "string" +}, +"context": { +"description": "Optional. Filter by intended context or domain (e.g. \"News, Commercial\"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified contexts (OR).", +"location": "query", +"repeated": true, +"type": "string" +}, +"gender": { +"description": "Optional. Filter by gender presentation (e.g. \"female\", \"male\", \"neutral\"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified genders (OR).", +"location": "query", +"repeated": true, +"type": "string" +}, +"languageCode": { +"description": "Optional. Filter by BCP-47 language code (e.g. \"en-US\"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified language codes (OR).", +"location": "query", +"repeated": true, +"type": "string" +}, +"pageSize": { +"description": "Optional. The maximum number of voices to return per page. The service may return fewer than this value. If unspecified, at most 50 voices are returned. The maximum value is 1000; values above 1000 are coerced to 1000.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "A page token, received from a previous `ListVoices` call. Provide this to retrieve the subsequent page. When paginating, all filter query parameters (`language_code`, `region_code`, `accent`, `persona`, `context`, `gender`, `pitch`, `type`, and `search`) must match the call that returned this token; otherwise the request fails with `INVALID_ARGUMENT`. `page_size` may change between pages.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. The parent that owns this collection of voices. Format: `projects/{project}/locations/{location}` Supported only by the Vertex API.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +}, +"persona": { +"description": "Optional. Filter by vocal persona (e.g. \"Warm, Friendly\"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified personas (OR).", +"location": "query", +"repeated": true, +"type": "string" +}, +"pitch": { +"description": "Optional. Filter by vocal pitch. Accepts `\"low\"`, `\"medium\"`, `\"high\"` (case-insensitive). If multiple values are specified, matches voices with any of the specified pitches (OR).", +"location": "query", +"repeated": true, +"type": "string" +}, +"regionCode": { +"description": "Optional. Filter by ISO 3166-1 alpha-2 or UN M.49 region code (e.g. \"US\", \"001\"). Case-insensitive exact match. If multiple values are specified, matches voices with any of the specified region codes (OR).", +"location": "query", +"repeated": true, +"type": "string" +}, +"search": { +"description": "Optional. Free-text substring search query matched case-insensitively against both `display_name` and `description`. Maximum 2048 bytes.", +"location": "query", +"type": "string" +}, +"type": { +"description": "Optional. Filter by voice type. Accepts `\"prebuilt\"`, `\"replicated\"`, `\"prompted\"` (case-insensitive). If multiple values are specified, matches voices with any of the specified types (OR).", +"location": "query", +"repeated": true, +"type": "string" +} +}, +"path": "v1beta1/{+parent}/voices:list", +"response": { +"$ref": "GoogleLearningVertexApiInteractionsV1beta1ListVoicesResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} } } }, @@ -51079,7 +51266,7 @@ } } }, -"revision": "20260920", +"revision": "20260930", "rootUrl": "https://aiplatform.googleapis.com/", "schemas": { "CloudAiLargeModelsVisionExperimentsResponse": { @@ -51098,12 +51285,8 @@ "id": "CloudAiLargeModelsVisionExperimentsResponseProEditResult", "properties": { "structuredPrompt": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "The output structured prompt produced by this edit.", -"type": "object" +"description": "The output structured prompt (JSON string) produced by this edit.", +"type": "string" } }, "type": "object" @@ -51366,12 +51549,8 @@ "type": "string" }, "structuredPrompt": { -"additionalProperties": { -"description": "Properties of the object.", -"type": "any" -}, -"description": "A JSON object containing the user's modified URF. The URF Editing Preamble will diff this against the original URF to determine what changed.", -"type": "object" +"description": "A JSON string containing the user's modified URF. The URF Editing Preamble will diff this against the original URF to determine what changed.", +"type": "string" } }, "type": "object" @@ -52081,6 +52260,22 @@ }, "type": "object" }, +"GenaiVertexV1beta1AudioData": { +"description": "Audio payload used for voice creation.", +"id": "GenaiVertexV1beta1AudioData", +"properties": { +"data": { +"description": "Required. The raw audio bytes.", +"format": "byte", +"type": "string" +}, +"mimeType": { +"description": "Required. The IANA MIME type of the audio data (for example, `audio/wav` or `audio/mpeg`).", +"type": "string" +} +}, +"type": "object" +}, "GenaiVertexV1beta1AudioDelta": { "id": "GenaiVertexV1beta1AudioDelta", "properties": { @@ -54731,6 +54926,21 @@ false }, "type": "object" }, +"GenaiVertexV1beta1SpeechAnnotation": { +"description": "Speech annotation for text content.", +"id": "GenaiVertexV1beta1SpeechAnnotation", +"properties": { +"speaker": { +"description": "The speaker to associate with this turn.", +"type": "string" +}, +"style": { +"description": "Style instruction for the speech synthesis.", +"type": "string" +} +}, +"type": "object" +}, "GenaiVertexV1beta1SpeechConfig": { "description": "The configuration for speech interaction.", "id": "GenaiVertexV1beta1SpeechConfig", @@ -54935,6 +55145,10 @@ false "$ref": "GenaiVertexV1beta1PlaceCitation", "description": "A place citation annotation." }, +"speechMetadata": { +"$ref": "GenaiVertexV1beta1SpeechAnnotation", +"description": "Speech annotation for text content." +}, "startIndex": { "description": "Start of segment of the response that is attributed to this source. Index indicates the start of the segment, measured in bytes.", "format": "int32", @@ -55679,6 +55893,141 @@ false }, "type": "object" }, +"GenaiVertexV1beta1Voice": { +"description": "A voice resource representing either a custom voice (created via `CreateVoice`) or a prebuilt system voice (returned by `ListVoices`).", +"id": "GenaiVertexV1beta1Voice", +"properties": { +"accent": { +"description": "Optional. Regional accent descriptor (e.g. \"American\", \"British\").", +"type": "string" +}, +"context": { +"description": "Optional. Optimal usage context or domain (e.g. \"Conversational\", \"Audiobook\", \"News\").", +"type": "string" +}, +"description": { +"description": "Optional. Descriptive summary of vocal timbre, personality, and tone.", +"type": "string" +}, +"displayName": { +"description": "Optional. User-provided display name for a stored voice (`store = true`), or the catalog name for a prebuilt voice.", +"type": "string" +}, +"expireTime": { +"description": "Output only. The timestamp at which a custom stored voice (`store = true`) or replicated voice key (`store = false`) expires. Unset for prebuilt catalog voices (`\"prebuilt\"`), which do not expire.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"gender": { +"description": "Optional. Perceived voice gender presentation (e.g. \"female\", \"male\", \"neutral\").", +"type": "string" +}, +"id": { +"description": "Output only. The unique identifier of the voice. * For Google-managed custom voices (`store = true`), this is a generated ID with prefix `voice_` (for example, `voice_abc123def456`). Pass `voices/{id}` as the `name` in `GetVoice` and `DeleteVoice`, and pass `{id}` directly to `SpeechConfig.voice_config.voice` (or `SpeechConfig.voice`) during speech synthesis. * For prebuilt catalog voices (`\"prebuilt\"` returned by `ListVoices`), this is the speaker name (for example, `Puck` or `Charon`). * Unset when `CreateVoice` is called with `store = false`.", +"readOnly": true, +"type": "string" +}, +"key": { +"description": "Output only. The client-managed voice replication key (with prefix `voicekey_`). Returned only by `CreateVoice` when `type` is `\"replicated\"` and `store` is `false`. Pass this key to `SpeechConfig.voice_config.voice` (or `SpeechConfig.voice`) during speech synthesis.", +"readOnly": true, +"type": "string" +}, +"languageCode": { +"description": "Optional. Primary BCP-47 language tag (e.g. \"en-US\", \"fr-FR\").", +"type": "string" +}, +"model": { +"description": "Optional. The model used to design or replicate the voice. If omitted in `CreateVoice`, defaults to the latest supported voice design model. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for custom voices (`\"prompted\"` and `\"replicated\"`); unset for `\"prebuilt\"` voices. Created voices can be synthesized across any supported TTS synthesis model.", +"type": "string" +}, +"persona": { +"description": "Optional. Intended persona or character archetype (e.g. \"Warm, Friendly\", \"Narrator\").", +"type": "string" +}, +"pitch": { +"description": "Optional. Voice pitch classification.", +"enum": [ +"PITCH_UNSPECIFIED", +"PITCH_LOW", +"PITCH_MEDIUM", +"PITCH_HIGH" +], +"enumDescriptions": [ +"Pitch is unspecified.", +"Lower pitch voice.", +"Medium pitch voice.", +"Higher pitch voice." +], +"type": "string" +}, +"prompted": { +"$ref": "GenaiVertexV1beta1VoicePromptedVoice", +"description": "Parameters for prompted voice generation. Required in `CreateVoice` when `type` is `\"prompted\"`. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for prompted voices." +}, +"regionCode": { +"description": "Optional. ISO 3166-1 alpha-2 or UN M.49 geographic region code (e.g. \"US\", \"GB\", \"001\").", +"type": "string" +}, +"replicated": { +"$ref": "GenaiVertexV1beta1VoiceReplicatedVoice", +"description": "Input only. Parameters for replicated voice generation. Required on input when `type` is `\"replicated\"`. Not returned in responses." +}, +"sampleAudio": { +"$ref": "GenaiVertexV1beta1AudioData", +"description": "Output only. Sample audio (synthesizer prompt audio) generated for a prompted voice. Populated only in `CreateVoice` and `GetVoice` responses when `type` is `\"prompted\"`; unset in `ListVoices` responses and for `\"replicated\"` or `\"prebuilt\"` voices.", +"readOnly": true +}, +"type": { +"description": "Required. The type of the voice. In `CreateVoice`, must be `\"replicated\"` or `\"prompted\"`. In `ListVoices` responses, may also be `\"prebuilt\"`.", +"enum": [ +"VOICE_TYPE_UNSPECIFIED", +"VOICE_TYPE_REPLICATED", +"VOICE_TYPE_PROMPTED", +"VOICE_TYPE_PREBUILT" +], +"enumDescriptions": [ +"Default value. This value is unused and must not be specified.", +"A custom voice replicated from a reference audio sample and speaker consent recording.", +"A custom voice generated from a natural-language text prompt (optionally editing or remixing a `base_voice`).", +"A built-in system voice from Google's voice catalog (e.g., `Puck`, `Charon`). Returned in responses; cannot be specified as the type in `CreateVoice`." +], +"type": "string" +}, +"usage": { +"$ref": "GenaiVertexV1beta1InteractionUsage", +"description": "Output only. Token usage statistics for the voice creation request. Populated only in the response of `CreateVoice` when `type` is `\"prompted\"`; unset for `\"replicated\"` and in `GetVoice` and `ListVoices` responses.", +"readOnly": true +} +}, +"type": "object" +}, +"GenaiVertexV1beta1VoicePromptedVoice": { +"description": "Parameters for prompted voice generation. Required in `CreateVoice` when `type` is `\"prompted\"`. Returned in `CreateVoice`, `GetVoice`, and `ListVoices` responses for prompted voices.", +"id": "GenaiVertexV1beta1VoicePromptedVoice", +"properties": { +"input": { +"description": "Required. The natural-language prompt describing the desired voice, e.g. \"A deep, booming male voice of a massive evil ogre in his middle years.\"", +"type": "string" +} +}, +"type": "object" +}, +"GenaiVertexV1beta1VoiceReplicatedVoice": { +"description": "Input only. Parameters for replicated voice generation. Required on input when `type` is `\"replicated\"`. Not returned in responses.", +"id": "GenaiVertexV1beta1VoiceReplicatedVoice", +"properties": { +"consentAudio": { +"$ref": "GenaiVertexV1beta1AudioData", +"description": "Required. Audio recording of the same speaker reading the required consent phrase, confirming authorization to replicate the voice." +}, +"sourceAudio": { +"$ref": "GenaiVertexV1beta1AudioData", +"description": "Required. The reference audio sample of the speaker's voice to replicate. Must be an unmodified recording of an adult human voice." +} +}, +"type": "object" +}, "GenaiVertexV1beta1WordInfo": { "description": "Word-level ASR annotation for transcription output. Carries the word text, optional timing, and optional speaker attribution.", "id": "GenaiVertexV1beta1WordInfo", @@ -55851,11 +56200,10 @@ false }, "status": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordStatus", -"description": "Output only. The status of the task, including the state, status message, and timestamp.", -"readOnly": true +"description": "Optional. The status of the task, including the state, status message, and timestamp." }, "ttl": { -"description": "Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: (0 seconds, 1000 days]", +"description": "Optional. Input only. The TTL (Time To Live) for the task. If not set, the task will expire in 24 hours by default. Valid range: [1 second, 1000 days], at second precision. The `nanos` component MUST be zero; sub-second TTLs are not supported because the task's expiration is persisted at second granularity.", "format": "google-duration", "type": "string" }, @@ -56077,11 +56425,10 @@ false "properties": { "message": { "$ref": "GoogleCloudAiplatformV1beta1A2ATaskRecordMessage", -"description": "Output only. The status message associated with the state.", -"readOnly": true +"description": "Optional. The status message associated with the state." }, "state": { -"description": "Output only. The current state of the task.", +"description": "Optional. The current state of the task.", "enum": [ "STATE_UNSPECIFIED", "TASK_STATE_SUBMITTED", @@ -56104,7 +56451,6 @@ false "Indicates that the agent has decided to not perform the task. This may be done during initial task creation or later once an agent has determined it can't or won't proceed. This is a terminal state.", "Indicates that authentication is required to proceed. This is an interrupted state." ], -"readOnly": true, "type": "string" }, "timestamp": { @@ -57011,7 +57357,7 @@ false "type": "object" }, "GoogleCloudAiplatformV1beta1AgentTool": { -"description": "A tool provides a list of actions available to the Agent during the process of executing a task.", +"description": "A tool provides a list of actions available to the Agent during the process of executing a task. Example JSON for an MCP server tool: { \"type\": \"mcp_server\", \"name\": \"my-mcp-server\", \"url\": \"https://api.example.com/mcp\", \"headers\": { \"Authorization\": \"Bearer token123\" } }", "id": "GoogleCloudAiplatformV1beta1AgentTool", "properties": { "headers": { @@ -57030,7 +57376,7 @@ false "type": "string" }, "url": { -"description": "Optional. Temporary: the tool's runtime reference, consumed by CreateAgent to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`. It is duplicated here (the resource name is already in `name`) only because the Agent service is not yet connected to Agent Registry to derive it from `name`; the Task Service instead resolves it from Agent Registry (GetMcpServer / GetEndpoint) at task creation.", +"description": "Optional. Fallback for the tool's runtime reference, consumed by `CreateAgent` to create the downstream AI App. Applicable when `type` is `mcp_server` or `endpoint`, and optional: the Agent service derives the runtime reference from `name` via Agent Registry (`GetMcpServer` / `GetEndpoint`), and reads this only when that lookup yields none.", "type": "string" } }, @@ -59467,6 +59813,31 @@ false "name": { "description": "Identifier. Name of the cache config. Format: - `projects/{project}/cacheConfig`.", "type": "string" +}, +"retentionConfig": { +"$ref": "GoogleCloudAiplatformV1beta1CacheConfigRetentionConfig", +"description": "Optional. Project-level retention type for implicit caching. On `GetCacheConfig` this is populated with the retention the project gets: a project that has stated no preference reports `DURABLE`. On `UpdateCacheConfig`, leaving it unset means the project states no preference. Whether that clears an existing preference depends on `update_mask`; see that field." +} +}, +"type": "object" +}, +"GoogleCloudAiplatformV1beta1CacheConfigRetentionConfig": { +"description": "Configures the retention behavior of GenAI implicit (automatic) context caching for this project.", +"id": "GoogleCloudAiplatformV1beta1CacheConfigRetentionConfig", +"properties": { +"retentionType": { +"description": "Optional. Retention type applied to implicit cache traffic for this project.", +"enum": [ +"RETENTION_TYPE_UNSPECIFIED", +"EPHEMERAL", +"DURABLE" +], +"enumDescriptions": [ +"Unspecified. Treated the same as `DURABLE`.", +"Restricts implicit caching to ephemeral, volatile-memory-backed retention only.", +"Allows implicit caching to use long-lived, durable-storage-backed retention." +], +"type": "string" } }, "type": "object" @@ -70415,6 +70786,10 @@ false "description": "Optional. The scope of the memories that should be generated. Memories will be consolidated across memories with the same scope. Must be provided unless the scope is defined in the source content. If `scope` is provided, it will override the scope defined in the source content. Scope values cannot contain the wildcard character '*'.", "type": "object" }, +"timeZone": { +"description": "Optional. The time zone of the conversation or caller, used as the baseline for resolving relative time expressions (e.g., \"yesterday\") and formatting timestamps. If not set, \"UTC\" is used. Must be a valid IANA Time Zone Database name, e.g. \"America/New_York\".", +"type": "string" +}, "vertexSessionSource": { "$ref": "GoogleCloudAiplatformV1beta1GenerateMemoriesRequestVertexSessionSource", "description": "Defines a Vertex Session as the source content from which to generate memories." @@ -80663,6 +81038,10 @@ false "$ref": "GoogleCloudAiplatformV1beta1PartMediaResolution", "description": "per part media resolution. Media resolution for the input media." }, +"speechMetadata": { +"$ref": "GoogleCloudAiplatformV1beta1SpeechMetadata", +"description": "Optional. Turn-level metadata for speech generation (e.g. Daikon speaker/style). May be set alongside `text` to attach speaker and style information to a text part." +}, "text": { "description": "Optional. The text content of the part. When sent from the VSCode Gemini Code Assist extension, references to @mentioned items will be converted to markdown boldface text. For example `@my-repo` will be converted to and sent as `**my-repo**` by the IDE agent.", "type": "string" @@ -82263,15 +82642,31 @@ false "description": "Spec for Veo data processing.", "id": "GoogleCloudAiplatformV1beta1ProcessDataRequestVeoSpec", "properties": { +"outpaintingMode": { +"description": "Optional. The mode of Veo Outpainting data processing to perform. Required (`DATA_PREPARATION` or `OUTPAINTING`) when `process_type` is `VEO_OUTPAINTING` (`OUTPAINTING_MODE_UNSPECIFIED` is rejected with `INVALID_ARGUMENT`). Must not be set when `process_type` is not `VEO_OUTPAINTING` (rejected with `INVALID_ARGUMENT`).", +"enum": [ +"OUTPAINTING_MODE_UNSPECIFIED", +"DATA_PREPARATION", +"OUTPAINTING" +], +"enumDescriptions": [ +"Unspecified outpainting mode. Must not be used when `process_type` is `VEO_OUTPAINTING` (rejected with `INVALID_ARGUMENT`).", +"Stage 1 data preparation mode for Veo Outpainting.", +"Stage 2 outpainting video processing mode for Veo Outpainting." +], +"type": "string" +}, "processType": { "description": "Optional. The type of data processing to perform.", "enum": [ "VEO_V1_AND_V2_DEFAULT", -"VEO_V3" +"VEO_V3", +"VEO_OUTPAINTING" ], "enumDescriptions": [ "Process type for Veo 1 and 2.", -"Process type for Veo 3." +"Process type for Veo 3.", +"Process type for Veo Outpainting: prepares data for extending video content beyond its original boundaries or changing its aspect ratio." ], "type": "string" } @@ -87793,6 +88188,10 @@ false "description": "Optional. Whether a persistent disk is attached to sandboxes created from this template. Defaults to `false`. This flag lets a template carry (and preserve) disk configuration while keeping the disk detached, so it can be toggled on later without re-specifying the rest of the config. When `false`, the remaining fields in this message are ignored.", "type": "boolean" }, +"mountPath": { +"description": "Optional. The absolute path inside the sandbox container at which the persistent disk is mounted. Defaults to `/workspace` when unset. Ignored when `enabled` is `false`. Only writes beneath this path land on the disk. Writes elsewhere go to the container's writable layer, which counts against the container's ephemeral storage and is lost when the sandbox's runtime is torn down, so this should be the directory the workload actually writes to. Paths that would shadow the container's system directories (for example `/etc`, `/proc`, or `/usr` itself) are rejected.", +"type": "string" +}, "sizeGb": { "description": "Optional. The size of the persistent disk in GB. Must be non-negative. When `enabled` is `true`, a positive value is required; when unset or zero while enabled, the service applies a default size. Ignored when `enabled` is `false`.", "format": "int64", @@ -92942,6 +93341,10 @@ false "description": "Optional. The user-defined name of the SemanticGovernancePolicy.", "type": "string" }, +"dryRun": { +"description": "Optional. If true, this policy is evaluated and its result is reported, but the policy is not enforced: a violation does not block the agent's action. Use this to validate a policy against real traffic before turning enforcement on. Defaults to `false`, meaning the policy is enforced. This setting applies only to this policy. If the SemanticGovernancePolicyEngine for the project is itself in dry run, every policy behaves as dry run regardless of this field.", +"type": "boolean" +}, "etag": { "description": "Optional. Used to perform consistent read-modify-write transactions. If provided, the request will only succeed if the etag matches the current value. Otherwise, an ABORTED error will be returned.", "type": "string" @@ -93699,6 +94102,21 @@ false }, "type": "object" }, +"GoogleCloudAiplatformV1beta1SpeechMetadata": { +"description": "Structured Metadata Sub-Message for Part", +"id": "GoogleCloudAiplatformV1beta1SpeechMetadata", +"properties": { +"speaker": { +"description": "Optional. Identifies which speaker is speaking this turn.", +"type": "string" +}, +"style": { +"description": "Optional. Natural language description of the vocal style (e.g., \"cheerful\").", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudAiplatformV1beta1StartNotebookRuntimeOperationMetadata": { "description": "Metadata information for NotebookService.StartNotebookRuntime.", "id": "GoogleCloudAiplatformV1beta1StartNotebookRuntimeOperationMetadata", @@ -96284,6 +96702,33 @@ false "description": "Tool to support computer use.", "id": "GoogleCloudAiplatformV1beta1ToolComputerUse", "properties": { +"disabledSafetyPolicies": { +"description": "Optional. Disabled safety policies for computer use.", +"items": { +"enum": [ +"SAFETY_POLICY_UNSPECIFIED", +"FINANCIAL_TRANSACTIONS", +"SENSITIVE_DATA_MODIFICATION", +"COMMUNICATION_TOOL", +"ACCOUNT_CREATION", +"DATA_MODIFICATION", +"USER_CONSENT_MANAGEMENT", +"LEGAL_TERMS_AND_AGREEMENTS" +], +"enumDescriptions": [ +"Unspecified safety policy. This value should not be used.", +"Financial transactions safety policy.", +"Sensitive data modification safety policy.", +"Communication tool safety policy.", +"Account creation safety policy.", +"Data modification safety policy.", +"User consent management safety policy.", +"Legal terms and agreements safety policy." +], +"type": "string" +}, +"type": "array" +}, "enablePromptInjectionDetection": { "description": "Optional. Enables the prompt injection detection check on computer-use request.", "type": "boolean" @@ -97559,6 +98004,11 @@ false "$ref": "GoogleCloudAiplatformV1beta1FullFineTuningSpec", "description": "Tuning Spec for Full Fine Tuning." }, +"gcsMetricsUri": { +"description": "Output only. The Cloud Storage metrics URI associated with this TuningJob.", +"readOnly": true, +"type": "string" +}, "labels": { "additionalProperties": { "type": "string" @@ -98862,6 +99312,10 @@ false "replicatedVoiceConfig": { "$ref": "GoogleCloudAiplatformV1beta1ReplicatedVoiceConfig", "description": "Optional. The configuration for a replicated voice. This enables users to replicate a voice from an audio sample." +}, +"voice": { +"description": "Optional. The speaker identifier for synthesis. Supported formats: * Speaker name for prebuilt voices (for example, `Orus` or `Kore`). * Voice ID for stored voices (for example, `voice_xxx`). * Voice replication key (for example, `voicekey_xxx`).", +"type": "string" } }, "type": "object" @@ -99253,6 +99707,56 @@ false }, "type": "object" }, +"GoogleLearningVertexApiInteractionsV1beta1CreateVoiceHttpTranscoderRequest": { +"description": "Request message for `VoicesHttpService.CreateVoiceHttp`.", +"id": "GoogleLearningVertexApiInteractionsV1beta1CreateVoiceHttpTranscoderRequest", +"properties": { +"httpBody": { +"$ref": "GoogleApiHttpBody", +"description": "Required. The request body containing the `CreateVoiceRequest` payload." +} +}, +"type": "object" +}, +"GoogleLearningVertexApiInteractionsV1beta1CreateVoiceRequest": { +"description": "Request message for `VoicesService.CreateVoice`.", +"id": "GoogleLearningVertexApiInteractionsV1beta1CreateVoiceRequest", +"properties": { +"store": { +"description": "Optional. Whether the created voice is persisted and managed by Google. * When `true`, Google stores the voice and returns `Voice.id` (for example, `voice_abc123def456`), which can be managed via `GetVoice`, `ListVoices`, and `DeleteVoice` and referenced by ID in synthesis requests. Projects are subject to a maximum active stored voice quota; exceeding the quota returns `RESOURCE_EXHAUSTED`. * When `false` (default), the voice is not stored by Google and `Voice.key` (for example, `voicekey_...`) is returned for client-side storage and synthesis. Optional discovery metadata fields on `voice` are not persisted or returned when `store` is `false`. * Required to be `true` when `voice.type` is `\"prompted\"` (otherwise fails with `INVALID_ARGUMENT`).", +"type": "boolean" +}, +"voice": { +"$ref": "GenaiVertexV1beta1Voice", +"description": "Required. The voice to create. `voice.model` is optional; if omitted, the service selects the default voice creation model. Output-only fields on `Voice` (`id`, `key`, `expire_time`, `usage`) are ignored if set." +} +}, +"type": "object" +}, +"GoogleLearningVertexApiInteractionsV1beta1DeleteVoiceResponse": { +"description": "Response message for `VoicesService.DeleteVoice`.", +"id": "GoogleLearningVertexApiInteractionsV1beta1DeleteVoiceResponse", +"properties": {}, +"type": "object" +}, +"GoogleLearningVertexApiInteractionsV1beta1ListVoicesResponse": { +"description": "Response message for `VoicesService.ListVoices`.", +"id": "GoogleLearningVertexApiInteractionsV1beta1ListVoicesResponse", +"properties": { +"nextPageToken": { +"description": "A token that can be sent as `page_token` to retrieve the next page. If empty, there are no subsequent pages.", +"type": "string" +}, +"voices": { +"description": "The voices from the specified collection.", +"items": { +"$ref": "GenaiVertexV1beta1Voice" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "id": "GoogleLongrunningListOperationsResponse", From 81b5cd30ddbc6a5536cf056f1d2886d80587c558 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:35 +0000 Subject: [PATCH 05/41] feat(alloydb): update the api #### alloydb:v1 The following keys were added: - schemas.Instance.properties.observabilityInstanceInfo (Total Keys: 2) - schemas.Instance.properties.queryInsightsInfo (Total Keys: 2) - schemas.ObservabilityInstanceInfo (Total Keys: 20) - schemas.QueryInsightsInstanceInfo (Total Keys: 14) #### alloydb:v1alpha The following keys were added: - schemas.Cluster.properties.expressConfig.$ref (Total Keys: 1) - schemas.ExpressConfig (Total Keys: 3) - schemas.Instance.properties.observabilityInstanceInfo (Total Keys: 2) - schemas.Instance.properties.queryInsightsInfo (Total Keys: 2) - schemas.ObservabilityInstanceInfo (Total Keys: 27) - schemas.QueryInsightsInstanceInfo (Total Keys: 14) #### alloydb:v1beta The following keys were added: - schemas.Cluster.properties.expressConfig.$ref (Total Keys: 1) - schemas.ExpressConfig (Total Keys: 3) - schemas.Instance.properties.observabilityInstanceInfo (Total Keys: 2) - schemas.Instance.properties.queryInsightsInfo (Total Keys: 2) - schemas.ObservabilityInstanceInfo (Total Keys: 27) - schemas.QueryInsightsInstanceInfo (Total Keys: 14) --- ...projects.locations.clusters.instances.html | 85 ++++++++++++ ...b_v1alpha.projects.locations.clusters.html | 21 +++ ...projects.locations.clusters.instances.html | 100 ++++++++++++++ ...db_v1beta.projects.locations.clusters.html | 21 +++ ...projects.locations.clusters.instances.html | 100 ++++++++++++++ .../discovery_cache/documents/alloydb.v1.json | 94 ++++++++++++- .../documents/alloydb.v1alpha.json | 125 +++++++++++++++++- .../documents/alloydb.v1beta.json | 125 +++++++++++++++++- 8 files changed, 668 insertions(+), 3 deletions(-) diff --git a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html index b00f4c5113..41e0361bb3 100644 --- a/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1.projects.locations.clusters.instances.html @@ -198,6 +198,16 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -247,6 +257,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, @@ -378,6 +395,16 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -427,6 +454,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, @@ -649,6 +683,16 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -698,6 +742,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, @@ -876,6 +927,16 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -925,6 +986,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, @@ -1045,6 +1113,16 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -1094,6 +1172,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "nodeCount": 42, # Read capacity, i.e. number of nodes in a read pool instance. }, diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html index 10b558fae5..349b628c6a 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.html @@ -255,6 +255,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -500,6 +503,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -853,6 +859,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -1133,6 +1142,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -1367,6 +1379,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -1670,6 +1685,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -1926,6 +1944,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, diff --git a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html index e35ee3dcc4..53d9cbe62e 100644 --- a/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1alpha.projects.locations.clusters.instances.html @@ -207,6 +207,19 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "assistiveExperiencesEnabled": True or False, # Output only. Whether assistive experiences are enabled for this AlloyDB instance. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackActiveQueryPlan": True or False, # Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead. + "trackClientAddress": True or False, # Output only. Track client address for an instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -256,6 +269,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. @@ -421,6 +441,19 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "assistiveExperiencesEnabled": True or False, # Output only. Whether assistive experiences are enabled for this AlloyDB instance. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackActiveQueryPlan": True or False, # Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead. + "trackClientAddress": True or False, # Output only. Track client address for an instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -470,6 +503,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. @@ -726,6 +766,19 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "assistiveExperiencesEnabled": True or False, # Output only. Whether assistive experiences are enabled for this AlloyDB instance. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackActiveQueryPlan": True or False, # Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead. + "trackClientAddress": True or False, # Output only. Track client address for an instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -775,6 +828,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. @@ -992,6 +1052,19 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "assistiveExperiencesEnabled": True or False, # Output only. Whether assistive experiences are enabled for this AlloyDB instance. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackActiveQueryPlan": True or False, # Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead. + "trackClientAddress": True or False, # Output only. Track client address for an instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -1041,6 +1114,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. @@ -1195,6 +1275,19 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "assistiveExperiencesEnabled": True or False, # Output only. Whether assistive experiences are enabled for this AlloyDB instance. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackActiveQueryPlan": True or False, # Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead. + "trackClientAddress": True or False, # Output only. Track client address for an instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -1244,6 +1337,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html index 51a03bd8f7..28f11824db 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.html @@ -255,6 +255,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -499,6 +502,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -851,6 +857,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -1130,6 +1139,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -1363,6 +1375,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -1665,6 +1680,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, @@ -1920,6 +1938,9 @@

Method Details

], }, "etag": "A String", # For Resource freshness validation (https://google.aip.dev/154) + "expressConfig": { # Configuration that allows the user to create an AlloyDB Express cluster. # Optional. Configuration that allows the customer to create an AlloyDB Express cluster. + "enabled": True or False, # Optional. Whether Express configuration is enabled for the cluster. + }, "geminiConfig": { # Deprecated and unused. This message will be removed in the near future. # Optional. Deprecated and unused. This field will be removed in the near future. "entitled": True or False, # Output only. Deprecated and unused. This field will be removed in the near future. }, diff --git a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html index 5d46ff57c2..c5267b1768 100644 --- a/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html +++ b/docs/dyn/alloydb_v1beta.projects.locations.clusters.instances.html @@ -207,6 +207,19 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "assistiveExperiencesEnabled": True or False, # Output only. Whether assistive experiences are enabled for this AlloyDB instance. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackActiveQueryPlan": True or False, # Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead. + "trackClientAddress": True or False, # Output only. Track client address for an instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -256,6 +269,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. @@ -420,6 +440,19 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "assistiveExperiencesEnabled": True or False, # Output only. Whether assistive experiences are enabled for this AlloyDB instance. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackActiveQueryPlan": True or False, # Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead. + "trackClientAddress": True or False, # Output only. Track client address for an instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -469,6 +502,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. @@ -724,6 +764,19 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "assistiveExperiencesEnabled": True or False, # Output only. Whether assistive experiences are enabled for this AlloyDB instance. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackActiveQueryPlan": True or False, # Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead. + "trackClientAddress": True or False, # Output only. Track client address for an instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -773,6 +826,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. @@ -989,6 +1049,19 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "assistiveExperiencesEnabled": True or False, # Output only. Whether assistive experiences are enabled for this AlloyDB instance. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackActiveQueryPlan": True or False, # Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead. + "trackClientAddress": True or False, # Output only. Track client address for an instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -1038,6 +1111,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. @@ -1191,6 +1271,19 @@

Method Details

"trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. This is read-only flag and only modifiable by internal API. "trackWaitEvents": True or False, # Track wait events during query execution for an instance. This flag is turned "on" by default but tracking is enabled only after observability enabled flag is also turned on. }, + "observabilityInstanceInfo": { # Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults. + "assistiveExperiencesEnabled": True or False, # Output only. Whether assistive experiences are enabled for this AlloyDB instance. + "enabled": True or False, # Output only. Observability feature status for an instance. + "maxQueryStringLength": 42, # Output only. Query string length. The default value is 10k. + "preserveComments": True or False, # Output only. Preserve comments in query string for an instance. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured by Insights per minute for all queries combined. + "recordApplicationTags": True or False, # Output only. Record application tags for an instance. + "trackActiveQueries": True or False, # Output only. Track actively running queries on the instance. + "trackActiveQueryPlan": True or False, # Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead. + "trackClientAddress": True or False, # Output only. Track client address for an instance. + "trackWaitEventTypes": True or False, # Output only. Track wait event types during query execution for an instance. + "trackWaitEvents": True or False, # Output only. Track wait events during query execution for an instance. + }, "outboundPublicIpAddresses": [ # Output only. All outbound public IP addresses configured for the instance. "A String", ], @@ -1240,6 +1333,13 @@

Method Details

"recordApplicationTags": True or False, # Record application tags for an instance. This flag is turned "on" by default. "recordClientAddress": True or False, # Record client address for an instance. Client address is PII information. This flag is turned "on" by default. }, + "queryInsightsInfo": { # Instance level Query Insights information, which is read-only and available in the output only. # Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults. + "enabled": True or False, # Output only. Whether Query Insights is enabled. + "queryPlansPerMinute": 42, # Output only. Number of query execution plans captured per minute. + "queryStringLength": 42, # Output only. Maximum query string length. + "recordApplicationTags": True or False, # Output only. Whether to record application tags. + "recordClientAddress": True or False, # Output only. Whether to record client address. + }, "readPoolConfig": { # Configuration for a read pool instance. # Read pool instance configuration. This is required if the value of instanceType is READ_POOL. "autoScalingConfig": { # Configuration for autoscaling. # Autoscaling configuration for the read pool instance. If not set, the read pool instance will not be autoscaled. "policy": { # Policy for the autoscaler. # Policy for the MIG autoscaler. diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1.json b/googleapiclient/discovery_cache/documents/alloydb.v1.json index 797548ba92..93de2a767c 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1.json @@ -1879,7 +1879,7 @@ } } }, -"revision": "20260917", +"revision": "20260924", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -3388,6 +3388,11 @@ false "$ref": "ObservabilityInstanceConfig", "description": "Configuration for observability." }, +"observabilityInstanceInfo": { +"$ref": "ObservabilityInstanceInfo", +"description": "Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults.", +"readOnly": true +}, "outboundPublicIpAddresses": { "description": "Output only. All outbound public IP addresses configured for the instance.", "items": { @@ -3414,6 +3419,11 @@ false "$ref": "QueryInsightsInstanceConfig", "description": "Configuration for query insights." }, +"queryInsightsInfo": { +"$ref": "QueryInsightsInstanceInfo", +"description": "Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults.", +"readOnly": true +}, "readPoolConfig": { "$ref": "ReadPoolConfig", "description": "Read pool instance configuration. This is required if the value of instanceType is READ_POOL." @@ -3926,6 +3936,54 @@ false }, "type": "object" }, +"ObservabilityInstanceInfo": { +"id": "ObservabilityInstanceInfo", +"properties": { +"enabled": { +"description": "Output only. Observability feature status for an instance.", +"readOnly": true, +"type": "boolean" +}, +"maxQueryStringLength": { +"description": "Output only. Query string length. The default value is 10k.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"preserveComments": { +"description": "Output only. Preserve comments in query string for an instance.", +"readOnly": true, +"type": "boolean" +}, +"queryPlansPerMinute": { +"description": "Output only. Number of query execution plans captured by Insights per minute for all queries combined.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"recordApplicationTags": { +"description": "Output only. Record application tags for an instance.", +"readOnly": true, +"type": "boolean" +}, +"trackActiveQueries": { +"description": "Output only. Track actively running queries on the instance.", +"readOnly": true, +"type": "boolean" +}, +"trackWaitEventTypes": { +"description": "Output only. Track wait event types during query execution for an instance.", +"readOnly": true, +"type": "boolean" +}, +"trackWaitEvents": { +"description": "Output only. Track wait events during query execution for an instance.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -4272,6 +4330,40 @@ false }, "type": "object" }, +"QueryInsightsInstanceInfo": { +"description": "Instance level Query Insights information, which is read-only and available in the output only.", +"id": "QueryInsightsInstanceInfo", +"properties": { +"enabled": { +"description": "Output only. Whether Query Insights is enabled.", +"readOnly": true, +"type": "boolean" +}, +"queryPlansPerMinute": { +"description": "Output only. Number of query execution plans captured per minute.", +"format": "uint32", +"readOnly": true, +"type": "integer" +}, +"queryStringLength": { +"description": "Output only. Maximum query string length.", +"format": "uint32", +"readOnly": true, +"type": "integer" +}, +"recordApplicationTags": { +"description": "Output only. Whether to record application tags.", +"readOnly": true, +"type": "boolean" +}, +"recordClientAddress": { +"description": "Output only. Whether to record client address.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, "ReadPoolConfig": { "description": "Configuration for a read pool instance.", "id": "ReadPoolConfig", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json index 09a1007d73..8cf34e8dec 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1alpha.json @@ -2086,7 +2086,7 @@ } } }, -"revision": "20260917", +"revision": "20260924", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2696,6 +2696,10 @@ false "description": "For Resource freshness validation (https://google.aip.dev/154)", "type": "string" }, +"expressConfig": { +"$ref": "ExpressConfig", +"description": "Optional. Configuration that allows the customer to create an AlloyDB Express cluster." +}, "geminiConfig": { "$ref": "GeminiClusterConfig", "deprecated": true, @@ -3478,6 +3482,17 @@ false }, "type": "object" }, +"ExpressConfig": { +"description": "Configuration that allows the user to create an AlloyDB Express cluster.", +"id": "ExpressConfig", +"properties": { +"enabled": { +"description": "Optional. Whether Express configuration is enabled for the cluster.", +"type": "boolean" +} +}, +"type": "object" +}, "FailoverInstanceRequest": { "description": "Message for triggering failover on an Instance", "id": "FailoverInstanceRequest", @@ -3865,6 +3880,11 @@ false "$ref": "ObservabilityInstanceConfig", "description": "Configuration for observability." }, +"observabilityInstanceInfo": { +"$ref": "ObservabilityInstanceInfo", +"description": "Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults.", +"readOnly": true +}, "outboundPublicIpAddresses": { "description": "Output only. All outbound public IP addresses configured for the instance.", "items": { @@ -3891,6 +3911,11 @@ false "$ref": "QueryInsightsInstanceConfig", "description": "Configuration for query insights." }, +"queryInsightsInfo": { +"$ref": "QueryInsightsInstanceInfo", +"description": "Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults.", +"readOnly": true +}, "readPoolConfig": { "$ref": "ReadPoolConfig", "description": "Read pool instance configuration. This is required if the value of instanceType is READ_POOL." @@ -4450,6 +4475,70 @@ false }, "type": "object" }, +"ObservabilityInstanceInfo": { +"id": "ObservabilityInstanceInfo", +"properties": { +"assistiveExperiencesEnabled": { +"description": "Output only. Whether assistive experiences are enabled for this AlloyDB instance.", +"readOnly": true, +"type": "boolean" +}, +"enabled": { +"description": "Output only. Observability feature status for an instance.", +"readOnly": true, +"type": "boolean" +}, +"maxQueryStringLength": { +"description": "Output only. Query string length. The default value is 10k.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"preserveComments": { +"description": "Output only. Preserve comments in query string for an instance.", +"readOnly": true, +"type": "boolean" +}, +"queryPlansPerMinute": { +"description": "Output only. Number of query execution plans captured by Insights per minute for all queries combined.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"recordApplicationTags": { +"description": "Output only. Record application tags for an instance.", +"readOnly": true, +"type": "boolean" +}, +"trackActiveQueries": { +"description": "Output only. Track actively running queries on the instance.", +"readOnly": true, +"type": "boolean" +}, +"trackActiveQueryPlan": { +"deprecated": true, +"description": "Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead.", +"readOnly": true, +"type": "boolean" +}, +"trackClientAddress": { +"description": "Output only. Track client address for an instance.", +"readOnly": true, +"type": "boolean" +}, +"trackWaitEventTypes": { +"description": "Output only. Track wait event types during query execution for an instance.", +"readOnly": true, +"type": "boolean" +}, +"trackWaitEvents": { +"description": "Output only. Track wait events during query execution for an instance.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -4825,6 +4914,40 @@ false }, "type": "object" }, +"QueryInsightsInstanceInfo": { +"description": "Instance level Query Insights information, which is read-only and available in the output only.", +"id": "QueryInsightsInstanceInfo", +"properties": { +"enabled": { +"description": "Output only. Whether Query Insights is enabled.", +"readOnly": true, +"type": "boolean" +}, +"queryPlansPerMinute": { +"description": "Output only. Number of query execution plans captured per minute.", +"format": "uint32", +"readOnly": true, +"type": "integer" +}, +"queryStringLength": { +"description": "Output only. Maximum query string length.", +"format": "uint32", +"readOnly": true, +"type": "integer" +}, +"recordApplicationTags": { +"description": "Output only. Whether to record application tags.", +"readOnly": true, +"type": "boolean" +}, +"recordClientAddress": { +"description": "Output only. Whether to record client address.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, "ReadPoolConfig": { "description": "Configuration for a read pool instance.", "id": "ReadPoolConfig", diff --git a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json index b0aea0ad88..ae9ff4b117 100644 --- a/googleapiclient/discovery_cache/documents/alloydb.v1beta.json +++ b/googleapiclient/discovery_cache/documents/alloydb.v1beta.json @@ -2083,7 +2083,7 @@ } } }, -"revision": "20260917", +"revision": "20260924", "rootUrl": "https://alloydb.googleapis.com/", "schemas": { "AuthorizedNetwork": { @@ -2682,6 +2682,10 @@ false "description": "For Resource freshness validation (https://google.aip.dev/154)", "type": "string" }, +"expressConfig": { +"$ref": "ExpressConfig", +"description": "Optional. Configuration that allows the customer to create an AlloyDB Express cluster." +}, "geminiConfig": { "$ref": "GeminiClusterConfig", "deprecated": true, @@ -3459,6 +3463,17 @@ false }, "type": "object" }, +"ExpressConfig": { +"description": "Configuration that allows the user to create an AlloyDB Express cluster.", +"id": "ExpressConfig", +"properties": { +"enabled": { +"description": "Optional. Whether Express configuration is enabled for the cluster.", +"type": "boolean" +} +}, +"type": "object" +}, "FailoverInstanceRequest": { "description": "Message for triggering failover on an Instance", "id": "FailoverInstanceRequest", @@ -3846,6 +3861,11 @@ false "$ref": "ObservabilityInstanceConfig", "description": "Configuration for observability." }, +"observabilityInstanceInfo": { +"$ref": "ObservabilityInstanceInfo", +"description": "Output only. Instance level observability information, contains the effective values of observability settings for this instance, by merging customer's provided `ObservabilityInstanceConfig` with the Observability defaults.", +"readOnly": true +}, "outboundPublicIpAddresses": { "description": "Output only. All outbound public IP addresses configured for the instance.", "items": { @@ -3872,6 +3892,11 @@ false "$ref": "QueryInsightsInstanceConfig", "description": "Configuration for query insights." }, +"queryInsightsInfo": { +"$ref": "QueryInsightsInstanceInfo", +"description": "Output only. Instance level Query Insights information, which is read-only and available in the output only. Contains the effective query insights settings for this instance, by merging customer's provided `QueryInsightsInstanceConfig` with the Query Insights defaults.", +"readOnly": true +}, "readPoolConfig": { "$ref": "ReadPoolConfig", "description": "Read pool instance configuration. This is required if the value of instanceType is READ_POOL." @@ -4426,6 +4451,70 @@ false }, "type": "object" }, +"ObservabilityInstanceInfo": { +"id": "ObservabilityInstanceInfo", +"properties": { +"assistiveExperiencesEnabled": { +"description": "Output only. Whether assistive experiences are enabled for this AlloyDB instance.", +"readOnly": true, +"type": "boolean" +}, +"enabled": { +"description": "Output only. Observability feature status for an instance.", +"readOnly": true, +"type": "boolean" +}, +"maxQueryStringLength": { +"description": "Output only. Query string length. The default value is 10k.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"preserveComments": { +"description": "Output only. Preserve comments in query string for an instance.", +"readOnly": true, +"type": "boolean" +}, +"queryPlansPerMinute": { +"description": "Output only. Number of query execution plans captured by Insights per minute for all queries combined.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"recordApplicationTags": { +"description": "Output only. Record application tags for an instance.", +"readOnly": true, +"type": "boolean" +}, +"trackActiveQueries": { +"description": "Output only. Track actively running queries on the instance.", +"readOnly": true, +"type": "boolean" +}, +"trackActiveQueryPlan": { +"deprecated": true, +"description": "Output only. Indicates whether to track active query plans for an instance. Deprecated: Use track_active_queries instead.", +"readOnly": true, +"type": "boolean" +}, +"trackClientAddress": { +"description": "Output only. Track client address for an instance.", +"readOnly": true, +"type": "boolean" +}, +"trackWaitEventTypes": { +"description": "Output only. Track wait event types during query execution for an instance.", +"readOnly": true, +"type": "boolean" +}, +"trackWaitEvents": { +"description": "Output only. Track wait events during query execution for an instance.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "Operation", @@ -4801,6 +4890,40 @@ false }, "type": "object" }, +"QueryInsightsInstanceInfo": { +"description": "Instance level Query Insights information, which is read-only and available in the output only.", +"id": "QueryInsightsInstanceInfo", +"properties": { +"enabled": { +"description": "Output only. Whether Query Insights is enabled.", +"readOnly": true, +"type": "boolean" +}, +"queryPlansPerMinute": { +"description": "Output only. Number of query execution plans captured per minute.", +"format": "uint32", +"readOnly": true, +"type": "integer" +}, +"queryStringLength": { +"description": "Output only. Maximum query string length.", +"format": "uint32", +"readOnly": true, +"type": "integer" +}, +"recordApplicationTags": { +"description": "Output only. Whether to record application tags.", +"readOnly": true, +"type": "boolean" +}, +"recordClientAddress": { +"description": "Output only. Whether to record client address.", +"readOnly": true, +"type": "boolean" +} +}, +"type": "object" +}, "ReadPoolConfig": { "description": "Configuration for a read pool instance.", "id": "ReadPoolConfig", From a37066c2b656ac0eb449ec134571f4049c1f3131 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:35 +0000 Subject: [PATCH 06/41] feat(androidmanagement): update the api #### androidmanagement:v1 The following keys were added: - schemas.CrossDevicePolicies.properties.taskContinuityHandoff.type (Total Keys: 1) - schemas.PersonalCrossDevicePolicies (Total Keys: 3) - schemas.PersonalUsagePolicies.properties.crossDevicePolicies.$ref (Total Keys: 1) --- ...roidmanagement_v1.enterprises.devices.html | 112 ++-- ...oidmanagement_v1.enterprises.policies.html | 624 +++++++++--------- .../documents/androidmanagement.v1.json | 113 ++-- 3 files changed, 456 insertions(+), 393 deletions(-) diff --git a/docs/dyn/androidmanagement_v1.enterprises.devices.html b/docs/dyn/androidmanagement_v1.enterprises.devices.html index bdad24f06c..aa257e6bc7 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.devices.html +++ b/docs/dyn/androidmanagement_v1.enterprises.devices.html @@ -186,20 +186,20 @@

Method Details

], "appliedPasswordPolicies": [ # The password requirements currently applied to the device. This field exists because the applied requirements may be slightly different from those specified in passwordPolicies in some cases. Note that this field does not provide information about password compliance. For non-compliance information, see nonComplianceDetails. NonComplianceDetail.fieldPath, is set based on passwordPolicies, not based on this field. { # Requirements for the password used to unlock a device. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, ], "appliedPolicyName": "A String", # The name of the policy currently applied to the device. @@ -623,20 +623,20 @@

Method Details

], "appliedPasswordPolicies": [ # The password requirements currently applied to the device. This field exists because the applied requirements may be slightly different from those specified in passwordPolicies in some cases. Note that this field does not provide information about password compliance. For non-compliance information, see nonComplianceDetails. NonComplianceDetail.fieldPath, is set based on passwordPolicies, not based on this field. { # Requirements for the password used to unlock a device. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, ], "appliedPolicyName": "A String", # The name of the policy currently applied to the device. @@ -928,20 +928,20 @@

Method Details

], "appliedPasswordPolicies": [ # The password requirements currently applied to the device. This field exists because the applied requirements may be slightly different from those specified in passwordPolicies in some cases. Note that this field does not provide information about password compliance. For non-compliance information, see nonComplianceDetails. NonComplianceDetail.fieldPath, is set based on passwordPolicies, not based on this field. { # Requirements for the password used to unlock a device. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, ], "appliedPolicyName": "A String", # The name of the policy currently applied to the device. @@ -1215,20 +1215,20 @@

Method Details

], "appliedPasswordPolicies": [ # The password requirements currently applied to the device. This field exists because the applied requirements may be slightly different from those specified in passwordPolicies in some cases. Note that this field does not provide information about password compliance. For non-compliance information, see nonComplianceDetails. NonComplianceDetail.fieldPath, is set based on passwordPolicies, not based on this field. { # Requirements for the password used to unlock a device. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, ], "appliedPolicyName": "A String", # The name of the policy currently applied to the device. diff --git a/docs/dyn/androidmanagement_v1.enterprises.policies.html b/docs/dyn/androidmanagement_v1.enterprises.policies.html index 28e9d7b398..f5a315d039 100644 --- a/docs/dyn/androidmanagement_v1.enterprises.policies.html +++ b/docs/dyn/androidmanagement_v1.enterprises.policies.html @@ -142,16 +142,16 @@

Method Details

], "addUserDisabled": True or False, # Whether adding new users and profiles is disabled. For devices where managementMode is DEVICE_OWNER this field is ignored and the user is never allowed to add or remove users. "adjustVolumeDisabled": True or False, # Whether adjusting the master volume is disabled. Also mutes the device. The setting has effect only on fully managed devices. - "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Advanced security settings. In most cases, setting these is not needed. - "commonCriteriaMode": "A String", # Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. + "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Optional. Advanced security settings. In most cases, setting these is not needed. + "commonCriteriaMode": "A String", # Optional. Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. "contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. - "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. - "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). + "developerSettings": "A String", # Optional. Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. + "googlePlayProtectVerifyApps": "A String", # Optional. Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. - "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. + "personalAppsThatCanReadWorkNotifications": [ # Optional. Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], - "untrustedAppsPolicy": "A String", # The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). + "untrustedAppsPolicy": "A String", # Optional. The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). }, "alwaysOnVpnPackage": { # Configuration for an always-on VPN connection. # Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting. "lockdownEnabled": True or False, # Disallows networking when the VPN is not connected. @@ -270,18 +270,19 @@

Method Details

"crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature. This policy applies to the entire device for fully managed devices, and to the work profile for devices with a work profile. Requires Android 17 QPR1 or higher. }, - "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. + "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Optional. Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. - "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. - "crossProfileDataSharing": "A String", # Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. - "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. + "crossProfileCopyPaste": "A String", # Optional. Whether text copied from one profile (personal or work) can be pasted in the other profile. + "crossProfileDataSharing": "A String", # Optional. Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. + "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # Optional. List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. "packageNames": [ # A list of package names. "A String", ], }, - "showWorkContactsInPersonalProfile": "A String", # Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. - "workProfileWidgetsDefault": "A String", # Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. + "showWorkContactsInPersonalProfile": "A String", # Optional. Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. + "workProfileWidgetsDefault": "A String", # Optional. Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. }, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. @@ -406,12 +407,12 @@

Method Details

"A String", ], "kioskCustomLauncherEnabled": True or False, # Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. Apps appear on a single page in alphabetical order. Use kioskCustomization to further configure the kiosk device behavior. - "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. - "deviceSettings": "A String", # Specifies whether the Settings app is allowed in kiosk mode. - "powerButtonActions": "A String", # Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. - "statusBar": "A String", # Specifies whether system info and notifications are disabled in kiosk mode. - "systemErrorWarnings": "A String", # Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. - "systemNavigation": "A String", # Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. + "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Optional. Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. + "deviceSettings": "A String", # Optional. Specifies whether the Settings app is allowed in kiosk mode. + "powerButtonActions": "A String", # Optional. Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. + "statusBar": "A String", # Optional. Specifies whether system info and notifications are disabled in kiosk mode. + "systemErrorWarnings": "A String", # Optional. Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. + "systemNavigation": "A String", # Optional. Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. }, "locationMode": "A String", # The degree of location detection enabled. "longSupportMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A message displayed to the user in the device administators settings screen. @@ -448,39 +449,39 @@

Method Details

}, "outgoingBeamDisabled": True or False, # Whether using NFC to beam data from apps is disabled. "outgoingCallsDisabled": True or False, # Whether outgoing calls are disabled. - "passwordPolicies": [ # Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. + "passwordPolicies": [ # Optional. Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. { # Requirements for the password used to unlock a device. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, ], "passwordRequirements": { # Requirements for the password used to unlock a device. # Password requirements. The field password_requirements.require_password_unlock must not be set. DEPRECATED - Use passwordPolicies.Note:Complexity-based values of PasswordQuality, that is, COMPLEXITY_LOW, COMPLEXITY_MEDIUM, and COMPLEXITY_HIGH, cannot be used here. unified_lock_settings cannot be used here. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, "permissionGrants": [ # Explicit permission or group grants or denials for all apps. These values override the default_permission_policy. { # Configuration for an Android permission and its grant state. @@ -515,6 +516,9 @@

Method Details

], "bluetoothSharing": "A String", # Optional. Whether bluetooth sharing is allowed. "cameraDisabled": True or False, # If true, the camera is disabled on the personal profile. + "crossDevicePolicies": { # Policies controlling cross-device communication in the personal profile. # Optional. Policies controlling cross-device communication in the personal profile. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature for the personal profile on company-owned devices with a work profile. To disable Handoff device-wide on a company-owned device, both crossDevicePolicies.taskContinuityHandoff and this policy should be set to TASK_CONTINUITY_HANDOFF_DISALLOWED. Requires Android 17 QPR1 or higher. + }, "maxDaysWithWorkOff": 42, # Controls how long the work profile can stay off. The minimum duration must be at least 3 days. Other details are as follows: - If the duration is set to 0, the feature is turned off. - If the duration is set to a value smaller than the minimum duration, the feature returns an error. *Note:* If you want to avoid personal profiles being suspended during long periods of off-time, you can temporarily set a large value for this parameter. "personalApplications": [ # Policy applied to applications in the personal profile. { # Policies for apps in the personal profile of a company-owned device with a work profile. @@ -626,11 +630,11 @@

Method Details

"tetheringConfigDisabled": True or False, # Whether configuring tethering and portable hotspots is disabled. If tetheringSettings is set to anything other than TETHERING_SETTINGS_UNSPECIFIED, this setting is ignored. "uninstallAppsDisabled": True or False, # Whether user uninstallation of applications is disabled. This prevents apps from being uninstalled, even those removed using applications "unmuteMicrophoneDisabled": True or False, # If microphone_access is set to any value other than MICROPHONE_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether microphones are disabled: If true, all microphones are disabled, otherwise they are available. This is available only on fully managed devices. - "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Configuration of device activity logging. - "enabledLogTypes": [ # Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. + "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Optional. Configuration of device activity logging. + "enabledLogTypes": [ # Optional. Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. "A String", ], - "uploadOnCellularAllowed": [ # Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. + "uploadOnCellularAllowed": [ # Optional. Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. "A String", ], }, @@ -675,16 +679,16 @@

Method Details

], "addUserDisabled": True or False, # Whether adding new users and profiles is disabled. For devices where managementMode is DEVICE_OWNER this field is ignored and the user is never allowed to add or remove users. "adjustVolumeDisabled": True or False, # Whether adjusting the master volume is disabled. Also mutes the device. The setting has effect only on fully managed devices. - "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Advanced security settings. In most cases, setting these is not needed. - "commonCriteriaMode": "A String", # Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. + "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Optional. Advanced security settings. In most cases, setting these is not needed. + "commonCriteriaMode": "A String", # Optional. Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. "contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. - "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. - "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). + "developerSettings": "A String", # Optional. Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. + "googlePlayProtectVerifyApps": "A String", # Optional. Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. - "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. + "personalAppsThatCanReadWorkNotifications": [ # Optional. Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], - "untrustedAppsPolicy": "A String", # The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). + "untrustedAppsPolicy": "A String", # Optional. The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). }, "alwaysOnVpnPackage": { # Configuration for an always-on VPN connection. # Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting. "lockdownEnabled": True or False, # Disallows networking when the VPN is not connected. @@ -803,18 +807,19 @@

Method Details

"crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature. This policy applies to the entire device for fully managed devices, and to the work profile for devices with a work profile. Requires Android 17 QPR1 or higher. }, - "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. + "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Optional. Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. - "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. - "crossProfileDataSharing": "A String", # Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. - "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. + "crossProfileCopyPaste": "A String", # Optional. Whether text copied from one profile (personal or work) can be pasted in the other profile. + "crossProfileDataSharing": "A String", # Optional. Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. + "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # Optional. List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. "packageNames": [ # A list of package names. "A String", ], }, - "showWorkContactsInPersonalProfile": "A String", # Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. - "workProfileWidgetsDefault": "A String", # Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. + "showWorkContactsInPersonalProfile": "A String", # Optional. Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. + "workProfileWidgetsDefault": "A String", # Optional. Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. }, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. @@ -939,12 +944,12 @@

Method Details

"A String", ], "kioskCustomLauncherEnabled": True or False, # Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. Apps appear on a single page in alphabetical order. Use kioskCustomization to further configure the kiosk device behavior. - "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. - "deviceSettings": "A String", # Specifies whether the Settings app is allowed in kiosk mode. - "powerButtonActions": "A String", # Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. - "statusBar": "A String", # Specifies whether system info and notifications are disabled in kiosk mode. - "systemErrorWarnings": "A String", # Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. - "systemNavigation": "A String", # Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. + "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Optional. Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. + "deviceSettings": "A String", # Optional. Specifies whether the Settings app is allowed in kiosk mode. + "powerButtonActions": "A String", # Optional. Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. + "statusBar": "A String", # Optional. Specifies whether system info and notifications are disabled in kiosk mode. + "systemErrorWarnings": "A String", # Optional. Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. + "systemNavigation": "A String", # Optional. Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. }, "locationMode": "A String", # The degree of location detection enabled. "longSupportMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A message displayed to the user in the device administators settings screen. @@ -981,39 +986,39 @@

Method Details

}, "outgoingBeamDisabled": True or False, # Whether using NFC to beam data from apps is disabled. "outgoingCallsDisabled": True or False, # Whether outgoing calls are disabled. - "passwordPolicies": [ # Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. + "passwordPolicies": [ # Optional. Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. { # Requirements for the password used to unlock a device. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, ], "passwordRequirements": { # Requirements for the password used to unlock a device. # Password requirements. The field password_requirements.require_password_unlock must not be set. DEPRECATED - Use passwordPolicies.Note:Complexity-based values of PasswordQuality, that is, COMPLEXITY_LOW, COMPLEXITY_MEDIUM, and COMPLEXITY_HIGH, cannot be used here. unified_lock_settings cannot be used here. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, "permissionGrants": [ # Explicit permission or group grants or denials for all apps. These values override the default_permission_policy. { # Configuration for an Android permission and its grant state. @@ -1048,6 +1053,9 @@

Method Details

], "bluetoothSharing": "A String", # Optional. Whether bluetooth sharing is allowed. "cameraDisabled": True or False, # If true, the camera is disabled on the personal profile. + "crossDevicePolicies": { # Policies controlling cross-device communication in the personal profile. # Optional. Policies controlling cross-device communication in the personal profile. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature for the personal profile on company-owned devices with a work profile. To disable Handoff device-wide on a company-owned device, both crossDevicePolicies.taskContinuityHandoff and this policy should be set to TASK_CONTINUITY_HANDOFF_DISALLOWED. Requires Android 17 QPR1 or higher. + }, "maxDaysWithWorkOff": 42, # Controls how long the work profile can stay off. The minimum duration must be at least 3 days. Other details are as follows: - If the duration is set to 0, the feature is turned off. - If the duration is set to a value smaller than the minimum duration, the feature returns an error. *Note:* If you want to avoid personal profiles being suspended during long periods of off-time, you can temporarily set a large value for this parameter. "personalApplications": [ # Policy applied to applications in the personal profile. { # Policies for apps in the personal profile of a company-owned device with a work profile. @@ -1159,11 +1167,11 @@

Method Details

"tetheringConfigDisabled": True or False, # Whether configuring tethering and portable hotspots is disabled. If tetheringSettings is set to anything other than TETHERING_SETTINGS_UNSPECIFIED, this setting is ignored. "uninstallAppsDisabled": True or False, # Whether user uninstallation of applications is disabled. This prevents apps from being uninstalled, even those removed using applications "unmuteMicrophoneDisabled": True or False, # If microphone_access is set to any value other than MICROPHONE_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether microphones are disabled: If true, all microphones are disabled, otherwise they are available. This is available only on fully managed devices. - "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Configuration of device activity logging. - "enabledLogTypes": [ # Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. + "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Optional. Configuration of device activity logging. + "enabledLogTypes": [ # Optional. Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. "A String", ], - "uploadOnCellularAllowed": [ # Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. + "uploadOnCellularAllowed": [ # Optional. Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. "A String", ], }, @@ -1294,16 +1302,16 @@

Method Details

], "addUserDisabled": True or False, # Whether adding new users and profiles is disabled. For devices where managementMode is DEVICE_OWNER this field is ignored and the user is never allowed to add or remove users. "adjustVolumeDisabled": True or False, # Whether adjusting the master volume is disabled. Also mutes the device. The setting has effect only on fully managed devices. - "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Advanced security settings. In most cases, setting these is not needed. - "commonCriteriaMode": "A String", # Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. + "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Optional. Advanced security settings. In most cases, setting these is not needed. + "commonCriteriaMode": "A String", # Optional. Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. "contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. - "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. - "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). + "developerSettings": "A String", # Optional. Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. + "googlePlayProtectVerifyApps": "A String", # Optional. Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. - "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. + "personalAppsThatCanReadWorkNotifications": [ # Optional. Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], - "untrustedAppsPolicy": "A String", # The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). + "untrustedAppsPolicy": "A String", # Optional. The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). }, "alwaysOnVpnPackage": { # Configuration for an always-on VPN connection. # Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting. "lockdownEnabled": True or False, # Disallows networking when the VPN is not connected. @@ -1422,18 +1430,19 @@

Method Details

"crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature. This policy applies to the entire device for fully managed devices, and to the work profile for devices with a work profile. Requires Android 17 QPR1 or higher. }, - "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. + "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Optional. Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. - "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. - "crossProfileDataSharing": "A String", # Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. - "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. + "crossProfileCopyPaste": "A String", # Optional. Whether text copied from one profile (personal or work) can be pasted in the other profile. + "crossProfileDataSharing": "A String", # Optional. Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. + "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # Optional. List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. "packageNames": [ # A list of package names. "A String", ], }, - "showWorkContactsInPersonalProfile": "A String", # Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. - "workProfileWidgetsDefault": "A String", # Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. + "showWorkContactsInPersonalProfile": "A String", # Optional. Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. + "workProfileWidgetsDefault": "A String", # Optional. Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. }, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. @@ -1558,12 +1567,12 @@

Method Details

"A String", ], "kioskCustomLauncherEnabled": True or False, # Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. Apps appear on a single page in alphabetical order. Use kioskCustomization to further configure the kiosk device behavior. - "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. - "deviceSettings": "A String", # Specifies whether the Settings app is allowed in kiosk mode. - "powerButtonActions": "A String", # Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. - "statusBar": "A String", # Specifies whether system info and notifications are disabled in kiosk mode. - "systemErrorWarnings": "A String", # Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. - "systemNavigation": "A String", # Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. + "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Optional. Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. + "deviceSettings": "A String", # Optional. Specifies whether the Settings app is allowed in kiosk mode. + "powerButtonActions": "A String", # Optional. Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. + "statusBar": "A String", # Optional. Specifies whether system info and notifications are disabled in kiosk mode. + "systemErrorWarnings": "A String", # Optional. Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. + "systemNavigation": "A String", # Optional. Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. }, "locationMode": "A String", # The degree of location detection enabled. "longSupportMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A message displayed to the user in the device administators settings screen. @@ -1600,39 +1609,39 @@

Method Details

}, "outgoingBeamDisabled": True or False, # Whether using NFC to beam data from apps is disabled. "outgoingCallsDisabled": True or False, # Whether outgoing calls are disabled. - "passwordPolicies": [ # Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. + "passwordPolicies": [ # Optional. Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. { # Requirements for the password used to unlock a device. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, ], "passwordRequirements": { # Requirements for the password used to unlock a device. # Password requirements. The field password_requirements.require_password_unlock must not be set. DEPRECATED - Use passwordPolicies.Note:Complexity-based values of PasswordQuality, that is, COMPLEXITY_LOW, COMPLEXITY_MEDIUM, and COMPLEXITY_HIGH, cannot be used here. unified_lock_settings cannot be used here. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, "permissionGrants": [ # Explicit permission or group grants or denials for all apps. These values override the default_permission_policy. { # Configuration for an Android permission and its grant state. @@ -1667,6 +1676,9 @@

Method Details

], "bluetoothSharing": "A String", # Optional. Whether bluetooth sharing is allowed. "cameraDisabled": True or False, # If true, the camera is disabled on the personal profile. + "crossDevicePolicies": { # Policies controlling cross-device communication in the personal profile. # Optional. Policies controlling cross-device communication in the personal profile. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature for the personal profile on company-owned devices with a work profile. To disable Handoff device-wide on a company-owned device, both crossDevicePolicies.taskContinuityHandoff and this policy should be set to TASK_CONTINUITY_HANDOFF_DISALLOWED. Requires Android 17 QPR1 or higher. + }, "maxDaysWithWorkOff": 42, # Controls how long the work profile can stay off. The minimum duration must be at least 3 days. Other details are as follows: - If the duration is set to 0, the feature is turned off. - If the duration is set to a value smaller than the minimum duration, the feature returns an error. *Note:* If you want to avoid personal profiles being suspended during long periods of off-time, you can temporarily set a large value for this parameter. "personalApplications": [ # Policy applied to applications in the personal profile. { # Policies for apps in the personal profile of a company-owned device with a work profile. @@ -1778,11 +1790,11 @@

Method Details

"tetheringConfigDisabled": True or False, # Whether configuring tethering and portable hotspots is disabled. If tetheringSettings is set to anything other than TETHERING_SETTINGS_UNSPECIFIED, this setting is ignored. "uninstallAppsDisabled": True or False, # Whether user uninstallation of applications is disabled. This prevents apps from being uninstalled, even those removed using applications "unmuteMicrophoneDisabled": True or False, # If microphone_access is set to any value other than MICROPHONE_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether microphones are disabled: If true, all microphones are disabled, otherwise they are available. This is available only on fully managed devices. - "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Configuration of device activity logging. - "enabledLogTypes": [ # Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. + "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Optional. Configuration of device activity logging. + "enabledLogTypes": [ # Optional. Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. "A String", ], - "uploadOnCellularAllowed": [ # Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. + "uploadOnCellularAllowed": [ # Optional. Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. "A String", ], }, @@ -1818,16 +1830,16 @@

Method Details

], "addUserDisabled": True or False, # Whether adding new users and profiles is disabled. For devices where managementMode is DEVICE_OWNER this field is ignored and the user is never allowed to add or remove users. "adjustVolumeDisabled": True or False, # Whether adjusting the master volume is disabled. Also mutes the device. The setting has effect only on fully managed devices. - "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Advanced security settings. In most cases, setting these is not needed. - "commonCriteriaMode": "A String", # Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. + "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Optional. Advanced security settings. In most cases, setting these is not needed. + "commonCriteriaMode": "A String", # Optional. Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. "contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. - "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. - "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). + "developerSettings": "A String", # Optional. Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. + "googlePlayProtectVerifyApps": "A String", # Optional. Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. - "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. + "personalAppsThatCanReadWorkNotifications": [ # Optional. Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], - "untrustedAppsPolicy": "A String", # The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). + "untrustedAppsPolicy": "A String", # Optional. The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). }, "alwaysOnVpnPackage": { # Configuration for an always-on VPN connection. # Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting. "lockdownEnabled": True or False, # Disallows networking when the VPN is not connected. @@ -1946,18 +1958,19 @@

Method Details

"crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature. This policy applies to the entire device for fully managed devices, and to the work profile for devices with a work profile. Requires Android 17 QPR1 or higher. }, - "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. + "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Optional. Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. - "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. - "crossProfileDataSharing": "A String", # Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. - "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. + "crossProfileCopyPaste": "A String", # Optional. Whether text copied from one profile (personal or work) can be pasted in the other profile. + "crossProfileDataSharing": "A String", # Optional. Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. + "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # Optional. List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. "packageNames": [ # A list of package names. "A String", ], }, - "showWorkContactsInPersonalProfile": "A String", # Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. - "workProfileWidgetsDefault": "A String", # Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. + "showWorkContactsInPersonalProfile": "A String", # Optional. Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. + "workProfileWidgetsDefault": "A String", # Optional. Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. }, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. @@ -2082,12 +2095,12 @@

Method Details

"A String", ], "kioskCustomLauncherEnabled": True or False, # Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. Apps appear on a single page in alphabetical order. Use kioskCustomization to further configure the kiosk device behavior. - "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. - "deviceSettings": "A String", # Specifies whether the Settings app is allowed in kiosk mode. - "powerButtonActions": "A String", # Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. - "statusBar": "A String", # Specifies whether system info and notifications are disabled in kiosk mode. - "systemErrorWarnings": "A String", # Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. - "systemNavigation": "A String", # Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. + "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Optional. Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. + "deviceSettings": "A String", # Optional. Specifies whether the Settings app is allowed in kiosk mode. + "powerButtonActions": "A String", # Optional. Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. + "statusBar": "A String", # Optional. Specifies whether system info and notifications are disabled in kiosk mode. + "systemErrorWarnings": "A String", # Optional. Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. + "systemNavigation": "A String", # Optional. Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. }, "locationMode": "A String", # The degree of location detection enabled. "longSupportMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A message displayed to the user in the device administators settings screen. @@ -2124,39 +2137,39 @@

Method Details

}, "outgoingBeamDisabled": True or False, # Whether using NFC to beam data from apps is disabled. "outgoingCallsDisabled": True or False, # Whether outgoing calls are disabled. - "passwordPolicies": [ # Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. + "passwordPolicies": [ # Optional. Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. { # Requirements for the password used to unlock a device. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, ], "passwordRequirements": { # Requirements for the password used to unlock a device. # Password requirements. The field password_requirements.require_password_unlock must not be set. DEPRECATED - Use passwordPolicies.Note:Complexity-based values of PasswordQuality, that is, COMPLEXITY_LOW, COMPLEXITY_MEDIUM, and COMPLEXITY_HIGH, cannot be used here. unified_lock_settings cannot be used here. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, "permissionGrants": [ # Explicit permission or group grants or denials for all apps. These values override the default_permission_policy. { # Configuration for an Android permission and its grant state. @@ -2191,6 +2204,9 @@

Method Details

], "bluetoothSharing": "A String", # Optional. Whether bluetooth sharing is allowed. "cameraDisabled": True or False, # If true, the camera is disabled on the personal profile. + "crossDevicePolicies": { # Policies controlling cross-device communication in the personal profile. # Optional. Policies controlling cross-device communication in the personal profile. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature for the personal profile on company-owned devices with a work profile. To disable Handoff device-wide on a company-owned device, both crossDevicePolicies.taskContinuityHandoff and this policy should be set to TASK_CONTINUITY_HANDOFF_DISALLOWED. Requires Android 17 QPR1 or higher. + }, "maxDaysWithWorkOff": 42, # Controls how long the work profile can stay off. The minimum duration must be at least 3 days. Other details are as follows: - If the duration is set to 0, the feature is turned off. - If the duration is set to a value smaller than the minimum duration, the feature returns an error. *Note:* If you want to avoid personal profiles being suspended during long periods of off-time, you can temporarily set a large value for this parameter. "personalApplications": [ # Policy applied to applications in the personal profile. { # Policies for apps in the personal profile of a company-owned device with a work profile. @@ -2302,11 +2318,11 @@

Method Details

"tetheringConfigDisabled": True or False, # Whether configuring tethering and portable hotspots is disabled. If tetheringSettings is set to anything other than TETHERING_SETTINGS_UNSPECIFIED, this setting is ignored. "uninstallAppsDisabled": True or False, # Whether user uninstallation of applications is disabled. This prevents apps from being uninstalled, even those removed using applications "unmuteMicrophoneDisabled": True or False, # If microphone_access is set to any value other than MICROPHONE_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether microphones are disabled: If true, all microphones are disabled, otherwise they are available. This is available only on fully managed devices. - "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Configuration of device activity logging. - "enabledLogTypes": [ # Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. + "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Optional. Configuration of device activity logging. + "enabledLogTypes": [ # Optional. Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. "A String", ], - "uploadOnCellularAllowed": [ # Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. + "uploadOnCellularAllowed": [ # Optional. Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. "A String", ], }, @@ -2340,16 +2356,16 @@

Method Details

], "addUserDisabled": True or False, # Whether adding new users and profiles is disabled. For devices where managementMode is DEVICE_OWNER this field is ignored and the user is never allowed to add or remove users. "adjustVolumeDisabled": True or False, # Whether adjusting the master volume is disabled. Also mutes the device. The setting has effect only on fully managed devices. - "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Advanced security settings. In most cases, setting these is not needed. - "commonCriteriaMode": "A String", # Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. + "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Optional. Advanced security settings. In most cases, setting these is not needed. + "commonCriteriaMode": "A String", # Optional. Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. "contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. - "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. - "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). + "developerSettings": "A String", # Optional. Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. + "googlePlayProtectVerifyApps": "A String", # Optional. Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. - "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. + "personalAppsThatCanReadWorkNotifications": [ # Optional. Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], - "untrustedAppsPolicy": "A String", # The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). + "untrustedAppsPolicy": "A String", # Optional. The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). }, "alwaysOnVpnPackage": { # Configuration for an always-on VPN connection. # Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting. "lockdownEnabled": True or False, # Disallows networking when the VPN is not connected. @@ -2468,18 +2484,19 @@

Method Details

"crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature. This policy applies to the entire device for fully managed devices, and to the work profile for devices with a work profile. Requires Android 17 QPR1 or higher. }, - "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. + "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Optional. Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. - "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. - "crossProfileDataSharing": "A String", # Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. - "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. + "crossProfileCopyPaste": "A String", # Optional. Whether text copied from one profile (personal or work) can be pasted in the other profile. + "crossProfileDataSharing": "A String", # Optional. Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. + "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # Optional. List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. "packageNames": [ # A list of package names. "A String", ], }, - "showWorkContactsInPersonalProfile": "A String", # Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. - "workProfileWidgetsDefault": "A String", # Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. + "showWorkContactsInPersonalProfile": "A String", # Optional. Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. + "workProfileWidgetsDefault": "A String", # Optional. Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. }, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. @@ -2604,12 +2621,12 @@

Method Details

"A String", ], "kioskCustomLauncherEnabled": True or False, # Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. Apps appear on a single page in alphabetical order. Use kioskCustomization to further configure the kiosk device behavior. - "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. - "deviceSettings": "A String", # Specifies whether the Settings app is allowed in kiosk mode. - "powerButtonActions": "A String", # Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. - "statusBar": "A String", # Specifies whether system info and notifications are disabled in kiosk mode. - "systemErrorWarnings": "A String", # Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. - "systemNavigation": "A String", # Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. + "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Optional. Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. + "deviceSettings": "A String", # Optional. Specifies whether the Settings app is allowed in kiosk mode. + "powerButtonActions": "A String", # Optional. Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. + "statusBar": "A String", # Optional. Specifies whether system info and notifications are disabled in kiosk mode. + "systemErrorWarnings": "A String", # Optional. Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. + "systemNavigation": "A String", # Optional. Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. }, "locationMode": "A String", # The degree of location detection enabled. "longSupportMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A message displayed to the user in the device administators settings screen. @@ -2646,39 +2663,39 @@

Method Details

}, "outgoingBeamDisabled": True or False, # Whether using NFC to beam data from apps is disabled. "outgoingCallsDisabled": True or False, # Whether outgoing calls are disabled. - "passwordPolicies": [ # Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. + "passwordPolicies": [ # Optional. Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. { # Requirements for the password used to unlock a device. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, ], "passwordRequirements": { # Requirements for the password used to unlock a device. # Password requirements. The field password_requirements.require_password_unlock must not be set. DEPRECATED - Use passwordPolicies.Note:Complexity-based values of PasswordQuality, that is, COMPLEXITY_LOW, COMPLEXITY_MEDIUM, and COMPLEXITY_HIGH, cannot be used here. unified_lock_settings cannot be used here. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, "permissionGrants": [ # Explicit permission or group grants or denials for all apps. These values override the default_permission_policy. { # Configuration for an Android permission and its grant state. @@ -2713,6 +2730,9 @@

Method Details

], "bluetoothSharing": "A String", # Optional. Whether bluetooth sharing is allowed. "cameraDisabled": True or False, # If true, the camera is disabled on the personal profile. + "crossDevicePolicies": { # Policies controlling cross-device communication in the personal profile. # Optional. Policies controlling cross-device communication in the personal profile. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature for the personal profile on company-owned devices with a work profile. To disable Handoff device-wide on a company-owned device, both crossDevicePolicies.taskContinuityHandoff and this policy should be set to TASK_CONTINUITY_HANDOFF_DISALLOWED. Requires Android 17 QPR1 or higher. + }, "maxDaysWithWorkOff": 42, # Controls how long the work profile can stay off. The minimum duration must be at least 3 days. Other details are as follows: - If the duration is set to 0, the feature is turned off. - If the duration is set to a value smaller than the minimum duration, the feature returns an error. *Note:* If you want to avoid personal profiles being suspended during long periods of off-time, you can temporarily set a large value for this parameter. "personalApplications": [ # Policy applied to applications in the personal profile. { # Policies for apps in the personal profile of a company-owned device with a work profile. @@ -2824,11 +2844,11 @@

Method Details

"tetheringConfigDisabled": True or False, # Whether configuring tethering and portable hotspots is disabled. If tetheringSettings is set to anything other than TETHERING_SETTINGS_UNSPECIFIED, this setting is ignored. "uninstallAppsDisabled": True or False, # Whether user uninstallation of applications is disabled. This prevents apps from being uninstalled, even those removed using applications "unmuteMicrophoneDisabled": True or False, # If microphone_access is set to any value other than MICROPHONE_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether microphones are disabled: If true, all microphones are disabled, otherwise they are available. This is available only on fully managed devices. - "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Configuration of device activity logging. - "enabledLogTypes": [ # Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. + "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Optional. Configuration of device activity logging. + "enabledLogTypes": [ # Optional. Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. "A String", ], - "uploadOnCellularAllowed": [ # Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. + "uploadOnCellularAllowed": [ # Optional. Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. "A String", ], }, @@ -2878,16 +2898,16 @@

Method Details

], "addUserDisabled": True or False, # Whether adding new users and profiles is disabled. For devices where managementMode is DEVICE_OWNER this field is ignored and the user is never allowed to add or remove users. "adjustVolumeDisabled": True or False, # Whether adjusting the master volume is disabled. Also mutes the device. The setting has effect only on fully managed devices. - "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Advanced security settings. In most cases, setting these is not needed. - "commonCriteriaMode": "A String", # Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. + "advancedSecurityOverrides": { # Advanced security settings. In most cases, setting these is not needed. # Optional. Advanced security settings. In most cases, setting these is not needed. + "commonCriteriaMode": "A String", # Optional. Controls Common Criteria Mode—security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured. "contentProtectionPolicy": "A String", # Optional. Controls whether content protection, which scans for deceptive apps, is enabled. This is supported on Android 15 and above. - "developerSettings": "A String", # Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. - "googlePlayProtectVerifyApps": "A String", # Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). + "developerSettings": "A String", # Optional. Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported. + "googlePlayProtectVerifyApps": "A String", # Optional. Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated). "mtePolicy": "A String", # Optional. Controls Memory Tagging Extension (MTE) (https://source.android.com/docs/security/test/memory-safety/arm-mte) on the device. The device needs to be rebooted to apply changes to the MTE policy. On Android 15 and above, a NonComplianceDetail with PENDING is reported if the policy change is pending a device reboot. - "personalAppsThatCanReadWorkNotifications": [ # Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. + "personalAppsThatCanReadWorkNotifications": [ # Optional. Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name. "A String", ], - "untrustedAppsPolicy": "A String", # The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). + "untrustedAppsPolicy": "A String", # Optional. The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated). }, "alwaysOnVpnPackage": { # Configuration for an always-on VPN connection. # Configuration for an always-on VPN connection. Use with vpn_config_disabled to prevent modification of this setting. "lockdownEnabled": True or False, # Disallows networking when the VPN is not connected. @@ -3006,18 +3026,19 @@

Method Details

"crossDevicePolicies": { # Policies controlling cross-device communication. # Optional. Policies controlling cross-device communication. "nearbyAppStreaming": "A String", # Optional. Manages video streaming of apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. "nearbyNotificationStreaming": "A String", # Optional. Manages streaming of notifications from apps on the device for fully managed devices or in the work profile for devices with work profiles to nearby devices. This is supported on Android 13 and above. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature. This policy applies to the entire device for fully managed devices, and to the work profile for devices with a work profile. Requires Android 17 QPR1 or higher. }, - "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Cross-profile policies applied on the device. + "crossProfilePolicies": { # Controls the data from the work profile that can be accessed from the personal profile and vice versa. A NonComplianceDetail with MANAGEMENT_MODE is reported if the device does not have a work profile. # Optional. Cross-profile policies applied on the device. "crossProfileAppFunctions": "A String", # Optional. Controls whether personal profile apps can invoke app functions exposed by apps in the work profile. - "crossProfileCopyPaste": "A String", # Whether text copied from one profile (personal or work) can be pasted in the other profile. - "crossProfileDataSharing": "A String", # Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. - "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. + "crossProfileCopyPaste": "A String", # Optional. Whether text copied from one profile (personal or work) can be pasted in the other profile. + "crossProfileDataSharing": "A String", # Optional. Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately. + "exemptionsToShowWorkContactsInPersonalProfile": { # A list of package names. # Optional. List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14. "packageNames": [ # A list of package names. "A String", ], }, - "showWorkContactsInPersonalProfile": "A String", # Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. - "workProfileWidgetsDefault": "A String", # Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. + "showWorkContactsInPersonalProfile": "A String", # Optional. Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile. + "workProfileWidgetsDefault": "A String", # Optional. Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here. }, "dataRoamingDisabled": True or False, # Whether roaming data services are disabled. "debuggingFeaturesAllowed": True or False, # Whether the user is allowed to enable debugging features. @@ -3142,12 +3163,12 @@

Method Details

"A String", ], "kioskCustomLauncherEnabled": True or False, # Whether the kiosk custom launcher is enabled. This replaces the home screen with a launcher that locks down the device to the apps installed via the applications setting. Apps appear on a single page in alphabetical order. Use kioskCustomization to further configure the kiosk device behavior. - "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. - "deviceSettings": "A String", # Specifies whether the Settings app is allowed in kiosk mode. - "powerButtonActions": "A String", # Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. - "statusBar": "A String", # Specifies whether system info and notifications are disabled in kiosk mode. - "systemErrorWarnings": "A String", # Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. - "systemNavigation": "A String", # Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. + "kioskCustomization": { # Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. # Optional. Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK. + "deviceSettings": "A String", # Optional. Specifies whether the Settings app is allowed in kiosk mode. + "powerButtonActions": "A String", # Optional. Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button. + "statusBar": "A String", # Optional. Specifies whether system info and notifications are disabled in kiosk mode. + "systemErrorWarnings": "A String", # Optional. Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the "close app" option on the UI. + "systemNavigation": "A String", # Optional. Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode. }, "locationMode": "A String", # The degree of location detection enabled. "longSupportMessage": { # Provides a user-facing message with locale info. The maximum message length is 4096 characters. # A message displayed to the user in the device administators settings screen. @@ -3184,39 +3205,39 @@

Method Details

}, "outgoingBeamDisabled": True or False, # Whether using NFC to beam data from apps is disabled. "outgoingCallsDisabled": True or False, # Whether outgoing calls are disabled. - "passwordPolicies": [ # Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. + "passwordPolicies": [ # Optional. Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy. { # Requirements for the password used to unlock a device. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, ], "passwordRequirements": { # Requirements for the password used to unlock a device. # Password requirements. The field password_requirements.require_password_unlock must not be set. DEPRECATED - Use passwordPolicies.Note:Complexity-based values of PasswordQuality, that is, COMPLEXITY_LOW, COMPLEXITY_MEDIUM, and COMPLEXITY_HIGH, cannot be used here. unified_lock_settings cannot be used here. - "maximumFailedPasswordsForWipe": 42, # Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. - "passwordExpirationTimeout": "A String", # Password expiration timeout. - "passwordHistoryLength": 42, # The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. - "passwordMinimumLength": 42, # The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. - "passwordMinimumLetters": 42, # Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumLowerCase": 42, # Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNonLetter": 42, # Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumNumeric": 42, # Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumSymbols": 42, # Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. - "passwordMinimumUpperCase": 42, # Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. - "passwordQuality": "A String", # The required password quality. - "passwordScope": "A String", # The scope that the password requirement applies to. - "requirePasswordUnlock": "A String", # The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. - "unifiedLockSettings": "A String", # Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. + "maximumFailedPasswordsForWipe": 42, # Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction. + "passwordExpirationTimeout": "A String", # Optional. Password expiration timeout. + "passwordHistoryLength": 42, # Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction. + "passwordMinimumLength": 42, # Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX. + "passwordMinimumLetters": 42, # Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumLowerCase": 42, # Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNonLetter": 42, # Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumNumeric": 42, # Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumSymbols": 42, # Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX. + "passwordMinimumUpperCase": 42, # Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX. + "passwordQuality": "A String", # Optional. The required password quality. + "passwordScope": "A String", # Optional. The scope that the password requirement applies to. + "requirePasswordUnlock": "A String", # Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile. + "unifiedLockSettings": "A String", # Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION. }, "permissionGrants": [ # Explicit permission or group grants or denials for all apps. These values override the default_permission_policy. { # Configuration for an Android permission and its grant state. @@ -3251,6 +3272,9 @@

Method Details

], "bluetoothSharing": "A String", # Optional. Whether bluetooth sharing is allowed. "cameraDisabled": True or False, # If true, the camera is disabled on the personal profile. + "crossDevicePolicies": { # Policies controlling cross-device communication in the personal profile. # Optional. Policies controlling cross-device communication in the personal profile. + "taskContinuityHandoff": "A String", # Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature for the personal profile on company-owned devices with a work profile. To disable Handoff device-wide on a company-owned device, both crossDevicePolicies.taskContinuityHandoff and this policy should be set to TASK_CONTINUITY_HANDOFF_DISALLOWED. Requires Android 17 QPR1 or higher. + }, "maxDaysWithWorkOff": 42, # Controls how long the work profile can stay off. The minimum duration must be at least 3 days. Other details are as follows: - If the duration is set to 0, the feature is turned off. - If the duration is set to a value smaller than the minimum duration, the feature returns an error. *Note:* If you want to avoid personal profiles being suspended during long periods of off-time, you can temporarily set a large value for this parameter. "personalApplications": [ # Policy applied to applications in the personal profile. { # Policies for apps in the personal profile of a company-owned device with a work profile. @@ -3362,11 +3386,11 @@

Method Details

"tetheringConfigDisabled": True or False, # Whether configuring tethering and portable hotspots is disabled. If tetheringSettings is set to anything other than TETHERING_SETTINGS_UNSPECIFIED, this setting is ignored. "uninstallAppsDisabled": True or False, # Whether user uninstallation of applications is disabled. This prevents apps from being uninstalled, even those removed using applications "unmuteMicrophoneDisabled": True or False, # If microphone_access is set to any value other than MICROPHONE_ACCESS_UNSPECIFIED, this has no effect. Otherwise this field controls whether microphones are disabled: If true, all microphones are disabled, otherwise they are available. This is available only on fully managed devices. - "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Configuration of device activity logging. - "enabledLogTypes": [ # Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. + "usageLog": { # Controls types of device activity logs collected from the device and reported via Pub/Sub notification (https://developers.google.com/android/management/notifications). # Optional. Configuration of device activity logging. + "enabledLogTypes": [ # Optional. Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled. "A String", ], - "uploadOnCellularAllowed": [ # Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. + "uploadOnCellularAllowed": [ # Optional. Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi. "A String", ], }, diff --git a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json index f650dfa253..7bf2c46ad3 100644 --- a/googleapiclient/discovery_cache/documents/androidmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/androidmanagement.v1.json @@ -1265,7 +1265,7 @@ } } }, -"revision": "20260917", +"revision": "20261001", "rootUrl": "https://androidmanagement.googleapis.com/", "schemas": { "AdbShellCommandEvent": { @@ -1315,7 +1315,7 @@ "id": "AdvancedSecurityOverrides", "properties": { "commonCriteriaMode": { -"description": "Controls Common Criteria Mode\u2014security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured.", +"description": "Optional. Controls Common Criteria Mode\u2014security standards defined in the Common Criteria for Information Technology Security Evaluation (https://www.commoncriteriaportal.org/) (CC). Enabling Common Criteria Mode increases certain security components on a device, see CommonCriteriaMode for details.Warning: Common Criteria Mode enforces a strict security model typically only required for IT products used in national security systems and other highly sensitive organizations. Standard device use may be affected. Only enabled if required. If Common Criteria Mode is turned off after being enabled previously, all user-configured Wi-Fi networks may be lost and any enterprise-configured Wi-Fi networks that require user input may need to be reconfigured.", "enum": [ "COMMON_CRITERIA_MODE_UNSPECIFIED", "COMMON_CRITERIA_MODE_DISABLED", @@ -1345,7 +1345,7 @@ "type": "string" }, "developerSettings": { -"description": "Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported.", +"description": "Optional. Controls access to developer settings: developer options and safe boot. Replaces safeBootDisabled (deprecated) and debuggingFeaturesAllowed (deprecated). On personally-owned devices with a work profile, setting this policy will not disable safe boot. In this case, a NonComplianceDetail with MANAGEMENT_MODE is reported.", "enum": [ "DEVELOPER_SETTINGS_UNSPECIFIED", "DEVELOPER_SETTINGS_DISABLED", @@ -1359,7 +1359,7 @@ "type": "string" }, "googlePlayProtectVerifyApps": { -"description": "Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated).", +"description": "Optional. Whether Google Play Protect verification (https://support.google.com/accounts/answer/2812853) is enforced. Replaces ensureVerifyAppsEnabled (deprecated).", "enum": [ "GOOGLE_PLAY_PROTECT_VERIFY_APPS_UNSPECIFIED", "VERIFY_APPS_ENFORCED", @@ -1389,14 +1389,14 @@ "type": "string" }, "personalAppsThatCanReadWorkNotifications": { -"description": "Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name.", +"description": "Optional. Personal apps that can read work profile notifications using a NotificationListenerService (https://developer.android.com/reference/android/service/notification/NotificationListenerService). By default, no personal apps (aside from system apps) can read work notifications. Each value in the list must be a package name.", "items": { "type": "string" }, "type": "array" }, "untrustedAppsPolicy": { -"description": "The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated).", +"description": "Optional. The policy for untrusted apps (apps from unknown sources) enforced on the device. Replaces install_unknown_sources_allowed (deprecated).", "enum": [ "UNTRUSTED_APPS_POLICY_UNSPECIFIED", "DISALLOW_INSTALL", @@ -2962,6 +2962,20 @@ false "The user is allowed to choose whether to stream notifications to other nearby devices which are signed in with the same authenticated managed account." ], "type": "string" +}, +"taskContinuityHandoff": { +"description": "Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature. This policy applies to the entire device for fully managed devices, and to the work profile for devices with a work profile. Requires Android 17 QPR1 or higher.", +"enum": [ +"TASK_CONTINUITY_HANDOFF_UNSPECIFIED", +"TASK_CONTINUITY_HANDOFF_ALLOWED", +"TASK_CONTINUITY_HANDOFF_DISALLOWED" +], +"enumDescriptions": [ +"Defaults to TASK_CONTINUITY_HANDOFF_ALLOWED.", +"Allows the user to enable or disable the task continuity handoff feature in settings. A NonComplianceDetail with API_LEVEL is reported if the Android version is lower than Android 17 QPR1.", +"The task continuity handoff feature is disallowed. A NonComplianceDetail with API_LEVEL is reported if the Android version is lower than Android 17 QPR1." +], +"type": "string" } }, "type": "object" @@ -2985,7 +2999,7 @@ false "type": "string" }, "crossProfileCopyPaste": { -"description": "Whether text copied from one profile (personal or work) can be pasted in the other profile.", +"description": "Optional. Whether text copied from one profile (personal or work) can be pasted in the other profile.", "enum": [ "CROSS_PROFILE_COPY_PASTE_UNSPECIFIED", "COPY_FROM_WORK_TO_PERSONAL_DISALLOWED", @@ -2999,7 +3013,7 @@ false "type": "string" }, "crossProfileDataSharing": { -"description": "Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately.", +"description": "Optional. Whether data from one profile (personal or work) can be shared with apps in the other profile. Specifically controls simple data sharing via intents. Management of other cross-profile communication channels, such as contact search, copy/paste, or connected work & personal apps, are configured separately.", "enum": [ "CROSS_PROFILE_DATA_SHARING_UNSPECIFIED", "CROSS_PROFILE_DATA_SHARING_DISALLOWED", @@ -3016,10 +3030,10 @@ false }, "exemptionsToShowWorkContactsInPersonalProfile": { "$ref": "PackageNameList", -"description": "List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14." +"description": "Optional. List of apps which are excluded from the ShowWorkContactsInPersonalProfile setting. For this to be set, ShowWorkContactsInPersonalProfile must be set to one of the following values: SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_ALLOWED. In this case, these exemptions act as a blocklist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED. In this case, these exemptions act as an allowlist. SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED_EXCEPT_SYSTEM. In this case, these exemptions act as an allowlist, in addition to the already allowlisted system apps.Supported on Android 14 and above. A NonComplianceDetail with API_LEVEL is reported if the Android version is less than 14." }, "showWorkContactsInPersonalProfile": { -"description": "Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile.", +"description": "Optional. Whether personal apps can access contacts stored in the work profile.See also exemptions_to_show_work_contacts_in_personal_profile.", "enum": [ "SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_UNSPECIFIED", "SHOW_WORK_CONTACTS_IN_PERSONAL_PROFILE_DISALLOWED", @@ -3035,7 +3049,7 @@ false "type": "string" }, "workProfileWidgetsDefault": { -"description": "Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here.", +"description": "Optional. Specifies the default behaviour for work profile widgets. If the policy does not specify work_profile_widgets for a specific application, it will behave according to the value specified here.", "enum": [ "WORK_PROFILE_WIDGETS_DEFAULT_UNSPECIFIED", "WORK_PROFILE_WIDGETS_DEFAULT_ALLOWED", @@ -4849,7 +4863,7 @@ false "id": "KioskCustomization", "properties": { "deviceSettings": { -"description": "Specifies whether the Settings app is allowed in kiosk mode.", +"description": "Optional. Specifies whether the Settings app is allowed in kiosk mode.", "enum": [ "DEVICE_SETTINGS_UNSPECIFIED", "SETTINGS_ACCESS_ALLOWED", @@ -4863,7 +4877,7 @@ false "type": "string" }, "powerButtonActions": { -"description": "Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button.", +"description": "Optional. Sets the behavior of a device in kiosk mode when a user presses and holds (long-presses) the Power button.", "enum": [ "POWER_BUTTON_ACTIONS_UNSPECIFIED", "POWER_BUTTON_AVAILABLE", @@ -4877,7 +4891,7 @@ false "type": "string" }, "statusBar": { -"description": "Specifies whether system info and notifications are disabled in kiosk mode.", +"description": "Optional. Specifies whether system info and notifications are disabled in kiosk mode.", "enum": [ "STATUS_BAR_UNSPECIFIED", "NOTIFICATIONS_AND_SYSTEM_INFO_ENABLED", @@ -4893,7 +4907,7 @@ false "type": "string" }, "systemErrorWarnings": { -"description": "Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the \"close app\" option on the UI.", +"description": "Optional. Specifies whether system error dialogs for crashed or unresponsive apps are blocked in kiosk mode. When blocked, the system will force-stop the app as if the user chooses the \"close app\" option on the UI.", "enum": [ "SYSTEM_ERROR_WARNINGS_UNSPECIFIED", "ERROR_AND_WARNINGS_ENABLED", @@ -4907,7 +4921,7 @@ false "type": "string" }, "systemNavigation": { -"description": "Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode.", +"description": "Optional. Specifies which navigation features are enabled (e.g. Home, Overview buttons) in kiosk mode.", "enum": [ "SYSTEM_NAVIGATION_UNSPECIFIED", "NAVIGATION_ENABLED", @@ -5768,57 +5782,57 @@ false "id": "PasswordRequirements", "properties": { "maximumFailedPasswordsForWipe": { -"description": "Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.", +"description": "Optional. Number of incorrect device-unlock passwords that can be entered before a device is wiped. A value of 0 means there is no restriction.", "format": "int32", "type": "integer" }, "passwordExpirationTimeout": { -"description": "Password expiration timeout.", +"description": "Optional. Password expiration timeout.", "format": "google-duration", "type": "string" }, "passwordHistoryLength": { -"description": "The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.", +"description": "Optional. The length of the password history. After setting this field, the user won't be able to enter a new password that is the same as any password in the history. A value of 0 means there is no restriction.", "format": "int32", "type": "integer" }, "passwordMinimumLength": { -"description": "The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.", +"description": "Optional. The minimum allowed password length. A value of 0 means there is no restriction. Only enforced when password_quality is NUMERIC, NUMERIC_COMPLEX, ALPHABETIC, ALPHANUMERIC, or COMPLEX.", "format": "int32", "type": "integer" }, "passwordMinimumLetters": { -"description": "Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.", +"description": "Optional. Minimum number of letters required in the password. Only enforced when password_quality is COMPLEX.", "format": "int32", "type": "integer" }, "passwordMinimumLowerCase": { -"description": "Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.", +"description": "Optional. Minimum number of lower case letters required in the password. Only enforced when password_quality is COMPLEX.", "format": "int32", "type": "integer" }, "passwordMinimumNonLetter": { -"description": "Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.", +"description": "Optional. Minimum number of non-letter characters (numerical digits or symbols) required in the password. Only enforced when password_quality is COMPLEX.", "format": "int32", "type": "integer" }, "passwordMinimumNumeric": { -"description": "Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.", +"description": "Optional. Minimum number of numerical digits required in the password. Only enforced when password_quality is COMPLEX.", "format": "int32", "type": "integer" }, "passwordMinimumSymbols": { -"description": "Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.", +"description": "Optional. Minimum number of symbols required in the password. Only enforced when password_quality is COMPLEX.", "format": "int32", "type": "integer" }, "passwordMinimumUpperCase": { -"description": "Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.", +"description": "Optional. Minimum number of upper case letters required in the password. Only enforced when password_quality is COMPLEX.", "format": "int32", "type": "integer" }, "passwordQuality": { -"description": "The required password quality.", +"description": "Optional. The required password quality.", "enum": [ "PASSWORD_QUALITY_UNSPECIFIED", "BIOMETRIC_WEAK", @@ -5848,7 +5862,7 @@ false "type": "string" }, "passwordScope": { -"description": "The scope that the password requirement applies to.", +"description": "Optional. The scope that the password requirement applies to.", "enum": [ "SCOPE_UNSPECIFIED", "SCOPE_DEVICE", @@ -5862,7 +5876,7 @@ false "type": "string" }, "requirePasswordUnlock": { -"description": "The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile.", +"description": "Optional. The length of time after a device or work profile is unlocked using a strong form of authentication (password, PIN, pattern) that it can be unlocked using any other authentication method (e.g. fingerprint, trust agents, face). After the specified time period elapses, only strong forms of authentication can be used to unlock the device or work profile.", "enum": [ "REQUIRE_PASSWORD_UNLOCK_UNSPECIFIED", "USE_DEFAULT_DEVICE_TIMEOUT", @@ -5876,7 +5890,7 @@ false "type": "string" }, "unifiedLockSettings": { -"description": "Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION.", +"description": "Optional. Controls whether a unified lock is allowed for the device and the work profile, on devices running Android 9 and above with a work profile. This can be set only if password_scope is set to SCOPE_PROFILE, the policy will be rejected otherwise. If user has not set a separate work lock and this field is set to REQUIRE_SEPARATE_WORK_LOCK, a NonComplianceDetail is reported with nonComplianceReason set to USER_ACTION.", "enum": [ "UNIFIED_LOCK_SETTINGS_UNSPECIFIED", "ALLOW_UNIFIED_WORK_AND_PERSONAL_LOCK", @@ -5994,6 +6008,27 @@ false }, "type": "object" }, +"PersonalCrossDevicePolicies": { +"description": "Policies controlling cross-device communication in the personal profile.", +"id": "PersonalCrossDevicePolicies", +"properties": { +"taskContinuityHandoff": { +"description": "Optional. Controls the task continuity handoff (https://developer.android.com/partners/android-17/features#handoff) feature for the personal profile on company-owned devices with a work profile. To disable Handoff device-wide on a company-owned device, both crossDevicePolicies.taskContinuityHandoff and this policy should be set to TASK_CONTINUITY_HANDOFF_DISALLOWED. Requires Android 17 QPR1 or higher.", +"enum": [ +"TASK_CONTINUITY_HANDOFF_UNSPECIFIED", +"TASK_CONTINUITY_HANDOFF_ALLOWED", +"TASK_CONTINUITY_HANDOFF_DISALLOWED" +], +"enumDescriptions": [ +"Defaults to TASK_CONTINUITY_HANDOFF_ALLOWED.", +"Allows the user to enable or disable the task continuity handoff feature in settings. A NonComplianceDetail with API_LEVEL is reported if the Android version is lower than Android 17 QPR1.", +"The task continuity handoff feature is disallowed. A NonComplianceDetail with API_LEVEL is reported if the Android version is lower than Android 17 QPR1." +], +"type": "string" +} +}, +"type": "object" +}, "PersonalUsagePolicies": { "description": "Policies controlling personal usage on a company-owned device with a work profile.", "id": "PersonalUsagePolicies", @@ -6023,6 +6058,10 @@ false "description": "If true, the camera is disabled on the personal profile.", "type": "boolean" }, +"crossDevicePolicies": { +"$ref": "PersonalCrossDevicePolicies", +"description": "Optional. Policies controlling cross-device communication in the personal profile." +}, "maxDaysWithWorkOff": { "description": "Controls how long the work profile can stay off. The minimum duration must be at least 3 days. Other details are as follows: - If the duration is set to 0, the feature is turned off. - If the duration is set to a value smaller than the minimum duration, the feature returns an error. *Note:* If you want to avoid personal profiles being suspended during long periods of off-time, you can temporarily set a large value for this parameter.", "format": "int32", @@ -6099,7 +6138,7 @@ false }, "advancedSecurityOverrides": { "$ref": "AdvancedSecurityOverrides", -"description": "Advanced security settings. In most cases, setting these is not needed." +"description": "Optional. Advanced security settings. In most cases, setting these is not needed." }, "alwaysOnVpnPackage": { "$ref": "AlwaysOnVpnPackage", @@ -6310,7 +6349,7 @@ false }, "crossProfilePolicies": { "$ref": "CrossProfilePolicies", -"description": "Cross-profile policies applied on the device." +"description": "Optional. Cross-profile policies applied on the device." }, "dataRoamingDisabled": { "description": "Whether roaming data services are disabled.", @@ -6462,7 +6501,7 @@ false }, "kioskCustomization": { "$ref": "KioskCustomization", -"description": "Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK." +"description": "Optional. Settings controlling the behavior of a device in kiosk mode. To enable kiosk mode, set kioskCustomLauncherEnabled to true or specify an app in the policy with installType KIOSK." }, "locationMode": { "description": "The degree of location detection enabled.", @@ -6576,7 +6615,7 @@ false "type": "boolean" }, "passwordPolicies": { -"description": "Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy.", +"description": "Optional. Password requirement policies. Different policies can be set for work profile or fully managed devices by setting the password_scope field in the policy.", "items": { "$ref": "PasswordRequirements" }, @@ -6762,7 +6801,7 @@ false }, "usageLog": { "$ref": "UsageLog", -"description": "Configuration of device activity logging." +"description": "Optional. Configuration of device activity logging." }, "usbFileTransferDisabled": { "deprecated": true, @@ -7846,7 +7885,7 @@ false "id": "UsageLog", "properties": { "enabledLogTypes": { -"description": "Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled.", +"description": "Optional. Specifies which log types are enabled. Note that users will receive on-device messaging when usage logging is enabled.", "items": { "enum": [ "LOG_TYPE_UNSPECIFIED", @@ -7863,7 +7902,7 @@ false "type": "array" }, "uploadOnCellularAllowed": { -"description": "Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi.", +"description": "Optional. Specifies which of the enabled log types can be uploaded over mobile data. By default logs are queued for upload when the device connects to WiFi.", "items": { "enum": [ "LOG_TYPE_UNSPECIFIED", From 11ed90b6b37be737f35f3475b269aa8f2f42bc7c Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:35 +0000 Subject: [PATCH 07/41] feat(assuredworkloads): update the api #### assuredworkloads:v1 The following keys were added: - resources.organizations.resources.locations.resources.workloads.resources.violations.methods.get.parameters.view (Total Keys: 2) - resources.organizations.resources.locations.resources.workloads.resources.violations.methods.list.parameters.view (Total Keys: 2) - schemas.GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest.properties.view.type (Total Keys: 1) - schemas.GoogleCloudAssuredworkloadsV1Violation.properties.affectedFrameworks (Total Keys: 3) - schemas.GoogleCloudAssuredworkloadsV1Violation.properties.childResourceViolationCount (Total Keys: 3) - schemas.GoogleCloudAssuredworkloadsV1Violation.properties.remediationMarkdown (Total Keys: 2) #### assuredworkloads:v1beta1 The following keys were added: - resources.organizations.resources.locations.resources.workloads.resources.violations.methods.get.parameters.view (Total Keys: 2) - resources.organizations.resources.locations.resources.workloads.resources.violations.methods.list.parameters.view (Total Keys: 2) - schemas.GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest.properties.view.type (Total Keys: 1) - schemas.GoogleCloudAssuredworkloadsV1beta1Violation.properties.affectedFrameworks (Total Keys: 3) - schemas.GoogleCloudAssuredworkloadsV1beta1Violation.properties.childResourceViolationCount (Total Keys: 3) - schemas.GoogleCloudAssuredworkloadsV1beta1Violation.properties.remediationMarkdown (Total Keys: 2) --- ...ations.locations.workloads.violations.html | 29 +++++++-- ...ations.locations.workloads.violations.html | 29 +++++++-- .../documents/assuredworkloads.v1.json | 65 ++++++++++++++++++- .../documents/assuredworkloads.v1beta1.json | 65 ++++++++++++++++++- 4 files changed, 178 insertions(+), 10 deletions(-) diff --git a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.violations.html b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.violations.html index ac865d1a89..dbe1c7c64b 100644 --- a/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.violations.html +++ b/docs/dyn/assuredworkloads_v1.organizations.locations.workloads.violations.html @@ -81,10 +81,10 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, x__xgafv=None)

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

Retrieves Assured Workload Violation based on ID.

- list(parent, filter=None, interval_endTime=None, interval_startTime=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

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

Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`

list_next(previous_request, previous_response)

@@ -103,6 +103,7 @@

Method Details

"acknowledgeType": "A String", # Optional. Acknowledge type of specified violation. "comment": "A String", # Required. Business justification explaining the need for violation acknowledgement "nonCompliantOrgPolicy": "A String", # Optional. This field is deprecated and will be removed in future version of the API. Name of the OrgPolicy which was modified with non-compliant change and resulted in this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name} + "view": "A String", # Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for acknowledging violations. } x__xgafv: string, V1 error format. @@ -123,11 +124,16 @@

Method Details

- get(name, x__xgafv=None) + get(name, view=None, x__xgafv=None)
Retrieves Assured Workload Violation based on ID.
 
 Args:
   name: string, Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} (required)
+  view: string, Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for fetching violations.
+    Allowed values
+      VIOLATION_VIEW_UNSPECIFIED - Defaults to the ASSURED_WORKLOADS view.
+      VIOLATION_VIEW_ASSURED_WORKLOADS - Includes the basic metadata about the violation.
+      VIOLATION_VIEW_DATA_BOUNDARY - Includes all information about the violation, including details about the data boundary.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -139,10 +145,14 @@ 

Method Details

{ # Workload monitoring Violation. "acknowledged": True or False, # A boolean that indicates if the violation is acknowledged "acknowledgementTime": "A String", # Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false. + "affectedFrameworks": [ # Output only. List of compliance frameworks that are affected by this violation. This field is only populated when using `VIOLATION_VIEW_DATA_BOUNDARY`. e.g. "FedRAMP High", "NIST 800-53". + "A String", + ], "associatedOrgPolicyViolationId": "A String", # Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations. "auditLogLink": "A String", # Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} "beginTime": "A String", # Output only. Time of the event which triggered the Violation. "category": "A String", # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc. + "childResourceViolationCount": 42, # Optional. Output only. The number of resource violations for particular org policy violation. This will be 0 in case of resource violation. "description": "A String", # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value. "exceptionAuditLogLink": "A String", # Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} "exceptionContexts": [ # Output only. List of all the exception detail added for the violation. @@ -186,6 +196,7 @@

Method Details

}, "remediationType": "A String", # Output only. Reemediation type based on the type of org policy values violated }, + "remediationMarkdown": "A String", # Output only. Contains the remediation instructions for the violation in markdown format. "resolveTime": "A String", # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty. "resourceName": "A String", # Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations. "resourceType": "A String", # Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations. @@ -196,7 +207,7 @@

Method Details

- list(parent, filter=None, interval_endTime=None, interval_startTime=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, interval_endTime=None, interval_startTime=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`
 
 Args:
@@ -207,6 +218,11 @@ 

Method Details

orderBy: string, Optional. Actionable sorting delegation. pageSize: integer, Optional. Page size. pageToken: string, Optional. Page token returned from previous request. + view: string, Optional. Specifies the violation view(AssuredWorkloads or DataBoundary) for fetching violations. + Allowed values + VIOLATION_VIEW_UNSPECIFIED - Defaults to the ASSURED_WORKLOADS view. + VIOLATION_VIEW_ASSURED_WORKLOADS - Includes the basic metadata about the violation. + VIOLATION_VIEW_DATA_BOUNDARY - Includes all information about the violation, including details about the data boundary. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -222,10 +238,14 @@

Method Details

{ # Workload monitoring Violation. "acknowledged": True or False, # A boolean that indicates if the violation is acknowledged "acknowledgementTime": "A String", # Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false. + "affectedFrameworks": [ # Output only. List of compliance frameworks that are affected by this violation. This field is only populated when using `VIOLATION_VIEW_DATA_BOUNDARY`. e.g. "FedRAMP High", "NIST 800-53". + "A String", + ], "associatedOrgPolicyViolationId": "A String", # Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations. "auditLogLink": "A String", # Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} "beginTime": "A String", # Output only. Time of the event which triggered the Violation. "category": "A String", # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc. + "childResourceViolationCount": 42, # Optional. Output only. The number of resource violations for particular org policy violation. This will be 0 in case of resource violation. "description": "A String", # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value. "exceptionAuditLogLink": "A String", # Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} "exceptionContexts": [ # Output only. List of all the exception detail added for the violation. @@ -269,6 +289,7 @@

Method Details

}, "remediationType": "A String", # Output only. Reemediation type based on the type of org policy values violated }, + "remediationMarkdown": "A String", # Output only. Contains the remediation instructions for the violation in markdown format. "resolveTime": "A String", # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty. "resourceName": "A String", # Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations. "resourceType": "A String", # Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations. diff --git a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.violations.html b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.violations.html index dc4fe32c2d..b2cd9b33a5 100644 --- a/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.violations.html +++ b/docs/dyn/assuredworkloads_v1beta1.organizations.locations.workloads.violations.html @@ -81,10 +81,10 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, x__xgafv=None)

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

Retrieves Assured Workload Violation based on ID.

- list(parent, filter=None, interval_endTime=None, interval_startTime=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)

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

Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`

list_next(previous_request, previous_response)

@@ -103,6 +103,7 @@

Method Details

"acknowledgeType": "A String", # Optional. Acknowledge type of specified violation. "comment": "A String", # Required. Business justification explaining the need for violation acknowledgement "nonCompliantOrgPolicy": "A String", # Optional. This field is deprecated and will be removed in future version of the API. Name of the OrgPolicy which was modified with non-compliant change and resulted in this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name} + "view": "A String", # Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for acknowledging violations. } x__xgafv: string, V1 error format. @@ -123,11 +124,16 @@

Method Details

- get(name, x__xgafv=None) + get(name, view=None, x__xgafv=None)
Retrieves Assured Workload Violation based on ID.
 
 Args:
   name: string, Required. The resource name of the Violation to fetch (ie. Violation.name). Format: organizations/{organization}/locations/{location}/workloads/{workload}/violations/{violation} (required)
+  view: string, Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for fetching violations.
+    Allowed values
+      VIOLATION_VIEW_UNSPECIFIED - Defaults to the ASSURED_WORKLOADS view.
+      VIOLATION_VIEW_ASSURED_WORKLOADS - Includes the basic metadata about the violation.
+      VIOLATION_VIEW_DATA_BOUNDARY - Includes all information about the violation, including details about the data boundary.
   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
@@ -139,10 +145,14 @@ 

Method Details

{ # Workload monitoring Violation. "acknowledged": True or False, # A boolean that indicates if the violation is acknowledged "acknowledgementTime": "A String", # Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false. + "affectedFrameworks": [ # Output only. List of compliance frameworks that are affected by this violation. This field is only populated when using `VIOLATION_VIEW_DATA_BOUNDARY`. e.g. "FedRAMP High", "NIST 800-53". + "A String", + ], "associatedOrgPolicyViolationId": "A String", # Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations. "auditLogLink": "A String", # Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} "beginTime": "A String", # Output only. Time of the event which triggered the Violation. "category": "A String", # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc. + "childResourceViolationCount": 42, # Optional. Output only. The number of resource violations for particular org policy violation. This will be 0 in case of resource violation. "description": "A String", # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value. "exceptionAuditLogLink": "A String", # Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} "exceptionContexts": [ # Output only. List of all the exception detail added for the violation. @@ -186,6 +196,7 @@

Method Details

}, "remediationType": "A String", # Output only. Reemediation type based on the type of org policy values violated }, + "remediationMarkdown": "A String", # Output only. Contains the remediation instructions for the violation in markdown format. "resolveTime": "A String", # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty. "resourceName": "A String", # Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations. "resourceType": "A String", # Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations. @@ -196,7 +207,7 @@

Method Details

- list(parent, filter=None, interval_endTime=None, interval_startTime=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, filter=None, interval_endTime=None, interval_startTime=None, orderBy=None, pageSize=None, pageToken=None, view=None, x__xgafv=None)
Lists the Violations in the AssuredWorkload Environment. Callers may also choose to read across multiple Workloads as per [AIP-159](https://google.aip.dev/159) by using '-' (the hyphen or dash character) as a wildcard character instead of workload-id in the parent. Format `organizations/{org_id}/locations/{location}/workloads/-`
 
 Args:
@@ -207,6 +218,11 @@ 

Method Details

orderBy: string, Optional. Actionable sorting delegation. pageSize: integer, Optional. Page size. pageToken: string, Optional. Page token returned from previous request. + view: string, Optional. Specifies the violation view(AssuredWorkloads or DataBoundary) for fetching violations. + Allowed values + VIOLATION_VIEW_UNSPECIFIED - Defaults to the ASSURED_WORKLOADS view. + VIOLATION_VIEW_ASSURED_WORKLOADS - Includes the basic metadata about the violation. + VIOLATION_VIEW_DATA_BOUNDARY - Includes all information about the violation, including details about the data boundary. x__xgafv: string, V1 error format. Allowed values 1 - v1 error format @@ -222,10 +238,14 @@

Method Details

{ # Workload monitoring Violation. "acknowledged": True or False, # A boolean that indicates if the violation is acknowledged "acknowledgementTime": "A String", # Optional. Timestamp when this violation was acknowledged first. Check exception_contexts to find the last time the violation was acknowledged when there are more than one violations. This field will be absent when acknowledged field is marked as false. + "affectedFrameworks": [ # Output only. List of compliance frameworks that are affected by this violation. This field is only populated when using `VIOLATION_VIEW_DATA_BOUNDARY`. e.g. "FedRAMP High", "NIST 800-53". + "A String", + ], "associatedOrgPolicyViolationId": "A String", # Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations. "auditLogLink": "A String", # Output only. Immutable. Audit Log Link for violated resource Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{timeRange}{folder} "beginTime": "A String", # Output only. Time of the event which triggered the Violation. "category": "A String", # Output only. Category under which this violation is mapped. e.g. Location, Service Usage, Access, Encryption, etc. + "childResourceViolationCount": 42, # Optional. Output only. The number of resource violations for particular org policy violation. This will be 0 in case of resource violation. "description": "A String", # Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value. "exceptionAuditLogLink": "A String", # Output only. Immutable. Audit Log link to find business justification provided for violation exception. Format: https://console.cloud.google.com/logs/query;query={logName}{protoPayload.resourceName}{protoPayload.methodName}{timeRange}{organization} "exceptionContexts": [ # Output only. List of all the exception detail added for the violation. @@ -269,6 +289,7 @@

Method Details

}, "remediationType": "A String", # Output only. Reemediation type based on the type of org policy values violated }, + "remediationMarkdown": "A String", # Output only. Contains the remediation instructions for the violation in markdown format. "resolveTime": "A String", # Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty. "resourceName": "A String", # Optional. Output only. Name of the resource like //storage.googleapis.com/myprojectxyz-testbucket. Empty for org-policy violations. "resourceType": "A String", # Optional. Output only. Type of the resource like compute.googleapis.com/Disk, etc. Empty for org-policy violations. diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json index d1cf1846dd..280eb0f3b8 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1.json @@ -1133,6 +1133,21 @@ "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for fetching violations.", +"enum": [ +"VIOLATION_VIEW_UNSPECIFIED", +"VIOLATION_VIEW_ASSURED_WORKLOADS", +"VIOLATION_VIEW_DATA_BOUNDARY" +], +"enumDescriptions": [ +"Defaults to the ASSURED_WORKLOADS view.", +"Includes the basic metadata about the violation.", +"Includes all information about the violation, including details about the data boundary." +], +"location": "query", +"type": "string" } }, "path": "v1/{+name}", @@ -1191,6 +1206,21 @@ "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. Specifies the violation view(AssuredWorkloads or DataBoundary) for fetching violations.", +"enum": [ +"VIOLATION_VIEW_UNSPECIFIED", +"VIOLATION_VIEW_ASSURED_WORKLOADS", +"VIOLATION_VIEW_DATA_BOUNDARY" +], +"enumDescriptions": [ +"Defaults to the ASSURED_WORKLOADS view.", +"Includes the basic metadata about the violation.", +"Includes all information about the violation, including details about the data boundary." +], +"location": "query", +"type": "string" } }, "path": "v1/{+parent}/violations", @@ -1452,7 +1482,7 @@ } } }, -"revision": "20260914", +"revision": "20260928", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1AcknowledgeViolationRequest": { @@ -1481,6 +1511,20 @@ "deprecated": true, "description": "Optional. This field is deprecated and will be removed in future version of the API. Name of the OrgPolicy which was modified with non-compliant change and resulted in this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}", "type": "string" +}, +"view": { +"description": "Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for acknowledging violations.", +"enum": [ +"VIOLATION_VIEW_UNSPECIFIED", +"VIOLATION_VIEW_ASSURED_WORKLOADS", +"VIOLATION_VIEW_DATA_BOUNDARY" +], +"enumDescriptions": [ +"Defaults to the ASSURED_WORKLOADS view.", +"Includes the basic metadata about the violation.", +"Includes all information about the violation, including details about the data boundary." +], +"type": "string" } }, "type": "object" @@ -2996,6 +3040,14 @@ false "format": "google-datetime", "type": "string" }, +"affectedFrameworks": { +"description": "Output only. List of compliance frameworks that are affected by this violation. This field is only populated when using `VIOLATION_VIEW_DATA_BOUNDARY`. e.g. \"FedRAMP High\", \"NIST 800-53\".", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "associatedOrgPolicyViolationId": { "description": "Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations.", "readOnly": true, @@ -3017,6 +3069,12 @@ false "readOnly": true, "type": "string" }, +"childResourceViolationCount": { +"description": "Optional. Output only. The number of resource violations for particular org policy violation. This will be 0 in case of resource violation.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "description": { "description": "Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.", "readOnly": true, @@ -3061,6 +3119,11 @@ false "description": "Output only. Compliance violation remediation", "readOnly": true }, +"remediationMarkdown": { +"description": "Output only. Contains the remediation instructions for the violation in markdown format.", +"readOnly": true, +"type": "string" +}, "resolveTime": { "description": "Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.", "format": "google-datetime", diff --git a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json index 84050ca670..f3c98c8119 100644 --- a/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/assuredworkloads.v1beta1.json @@ -1105,6 +1105,21 @@ "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+/violations/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for fetching violations.", +"enum": [ +"VIOLATION_VIEW_UNSPECIFIED", +"VIOLATION_VIEW_ASSURED_WORKLOADS", +"VIOLATION_VIEW_DATA_BOUNDARY" +], +"enumDescriptions": [ +"Defaults to the ASSURED_WORKLOADS view.", +"Includes the basic metadata about the violation.", +"Includes all information about the violation, including details about the data boundary." +], +"location": "query", +"type": "string" } }, "path": "v1beta1/{+name}", @@ -1163,6 +1178,21 @@ "pattern": "^organizations/[^/]+/locations/[^/]+/workloads/[^/]+$", "required": true, "type": "string" +}, +"view": { +"description": "Optional. Specifies the violation view(AssuredWorkloads or DataBoundary) for fetching violations.", +"enum": [ +"VIOLATION_VIEW_UNSPECIFIED", +"VIOLATION_VIEW_ASSURED_WORKLOADS", +"VIOLATION_VIEW_DATA_BOUNDARY" +], +"enumDescriptions": [ +"Defaults to the ASSURED_WORKLOADS view.", +"Includes the basic metadata about the violation.", +"Includes all information about the violation, including details about the data boundary." +], +"location": "query", +"type": "string" } }, "path": "v1beta1/{+parent}/violations", @@ -1424,7 +1454,7 @@ } } }, -"revision": "20260914", +"revision": "20260928", "rootUrl": "https://assuredworkloads.googleapis.com/", "schemas": { "GoogleCloudAssuredworkloadsV1beta1AcknowledgeViolationRequest": { @@ -1453,6 +1483,20 @@ "deprecated": true, "description": "Optional. This field is deprecated and will be removed in future version of the API. Name of the OrgPolicy which was modified with non-compliant change and resulted in this violation. Format: projects/{project_number}/policies/{constraint_name} folders/{folder_id}/policies/{constraint_name} organizations/{organization_id}/policies/{constraint_name}", "type": "string" +}, +"view": { +"description": "Optional. Specifies the violation view (`AssuredWorkloads` or `DataBoundary`) for acknowledging violations.", +"enum": [ +"VIOLATION_VIEW_UNSPECIFIED", +"VIOLATION_VIEW_ASSURED_WORKLOADS", +"VIOLATION_VIEW_DATA_BOUNDARY" +], +"enumDescriptions": [ +"Defaults to the ASSURED_WORKLOADS view.", +"Includes the basic metadata about the violation.", +"Includes all information about the violation, including details about the data boundary." +], +"type": "string" } }, "type": "object" @@ -2955,6 +2999,14 @@ false "format": "google-datetime", "type": "string" }, +"affectedFrameworks": { +"description": "Output only. List of compliance frameworks that are affected by this violation. This field is only populated when using `VIOLATION_VIEW_DATA_BOUNDARY`. e.g. \"FedRAMP High\", \"NIST 800-53\".", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "associatedOrgPolicyViolationId": { "description": "Optional. Output only. Violation Id of the org-policy violation due to which the resource violation is caused. Empty for org-policy violations.", "readOnly": true, @@ -2976,6 +3028,12 @@ false "readOnly": true, "type": "string" }, +"childResourceViolationCount": { +"description": "Optional. Output only. The number of resource violations for particular org policy violation. This will be 0 in case of resource violation.", +"format": "int32", +"readOnly": true, +"type": "integer" +}, "description": { "description": "Output only. Description for the Violation. e.g. OrgPolicy gcp.resourceLocations has non compliant value.", "readOnly": true, @@ -3020,6 +3078,11 @@ false "description": "Output only. Compliance violation remediation", "readOnly": true }, +"remediationMarkdown": { +"description": "Output only. Contains the remediation instructions for the violation in markdown format.", +"readOnly": true, +"type": "string" +}, "resolveTime": { "description": "Output only. Time of the event which fixed the Violation. If the violation is ACTIVE this will be empty.", "format": "google-datetime", From 36e7c0119e271f95394258764b4ecf11437ba9d2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:35 +0000 Subject: [PATCH 08/41] feat(bigquery): update the api #### bigquery:v2 The following keys were added: - schemas.ExternalRuntimeOptions.properties.volumeMounts (Total Keys: 2) - schemas.ExternalVolumeMount (Total Keys: 4) - schemas.JobConfigurationExtract.properties.nativeGeographyExportEnabled.type (Total Keys: 1) - schemas.JobConfigurationQuery.properties.secureContext.$ref (Total Keys: 1) - schemas.JobStatistics2.properties.referencedLogicalViews (Total Keys: 3) - schemas.QueryRequest.properties.secureContext.$ref (Total Keys: 1) - schemas.SecureContext (Total Keys: 4) The following keys were changed: - endpoints (Total Keys: 1) --- docs/dyn/bigquery_v2.jobs.html | 112 ++++++++++++++---- docs/dyn/bigquery_v2.routines.html | 36 ++++++ .../documents/bigquery.v2.json | 80 +++++++++++-- 3 files changed, 199 insertions(+), 29 deletions(-) diff --git a/docs/dyn/bigquery_v2.jobs.html b/docs/dyn/bigquery_v2.jobs.html index babd4643c9..99b2d4ded9 100644 --- a/docs/dyn/bigquery_v2.jobs.html +++ b/docs/dyn/bigquery_v2.jobs.html @@ -162,6 +162,7 @@

Method Details

"modelExtractOptions": { # Options related to model extraction. # Optional. Model extract options only applicable when extracting models. "trialId": "A String", # The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](https://cloud.google.com/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning. }, + "nativeGeographyExportEnabled": True or False, # Optional. Applicable to formats: PARQUET. If enabled, BigQuery to Parquet export will write the native Parquet Geography type instead of the default GeoParquet type. "printHeader": true, # Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models. "sourceModel": { # Id path of a model. # A reference to the model being exported. "datasetId": "A String", # Required. The ID of the dataset containing this model. @@ -428,6 +429,11 @@

Method Details

"statementByteBudget": "A String", # Limit on the number of bytes billed per statement. Exceeding this budget results in an error. "statementTimeoutMs": "A String", # Timeout period for each statement in a script. }, + "secureContext": { # A set of key-value pairs representing the secure context. # Optional. A set of key-value pairs representing the secure context. This can be used to pass sensitive or context-specific information. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "secureParameterEntries": { # Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "a_key": "", # Properties of the object. + }, + }, "systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables. "types": { # Output only. Data type for each system variable. "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } @@ -670,7 +676,7 @@

Method Details

], }, "finalExecutionDurationMs": "A String", # Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job. - "globalQueryRemoteRegions": [ # Output only. Regions where the global query accesses data. + "globalQueryRemoteRegions": [ # Output only. The list of remote regions from which a global query accesses data. This field is populated only for parent global query jobs in the primary execution region. It is empty for child global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries). "A String", ], "load": { # Statistics for a load job. # Output only. Statistics for a load job. @@ -692,7 +698,7 @@

Method Details

], }, "numChildJobs": "A String", # Output only. Number of child jobs executed. - "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. The global query that created this job. + "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. Reference to the parent global query job, if this is a child global query job. This field is populated only for child global query jobs (remote subqueries or cross-region table copy jobs) executed in remote regions on behalf of a global query. It contains the project ID, job ID, and location of the parent global query job. It is unset for parent global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries). "jobId": "A String", # Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. "location": "A String", # Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations "projectId": "A String", # Required. The ID of the project containing this job. @@ -1465,6 +1471,13 @@

Method Details

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. }, ], + "referencedLogicalViews": [ # Output only. Referenced logical views for the job. + { + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + ], "referencedPropertyGraphs": [ # Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. { # Id path of a property graph. "datasetId": "A String", # Required. The ID of the dataset containing this property graph. @@ -1594,7 +1607,7 @@

Method Details

"sparkJobId": "A String", # Output only. Spark job ID if a Spark job is created successfully. "sparkJobLocation": "A String", # Output only. Location where the Spark job is executed. A location is selected by BigQueury for jobs configured to run in a multi-region. }, - "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. + "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. "timeline": [ # Output only. Describes a timeline of job execution. { # Summary of the state of query execution at a given time. "activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. @@ -1682,7 +1695,7 @@

Method Details

"quotaDeferments": [ # Output only. Quotas which delayed this job's start time. "A String", ], - "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. + "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservations info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. "A String", ], "reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. @@ -1817,6 +1830,7 @@

Method Details

"modelExtractOptions": { # Options related to model extraction. # Optional. Model extract options only applicable when extracting models. "trialId": "A String", # The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](https://cloud.google.com/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning. }, + "nativeGeographyExportEnabled": True or False, # Optional. Applicable to formats: PARQUET. If enabled, BigQuery to Parquet export will write the native Parquet Geography type instead of the default GeoParquet type. "printHeader": true, # Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models. "sourceModel": { # Id path of a model. # A reference to the model being exported. "datasetId": "A String", # Required. The ID of the dataset containing this model. @@ -2083,6 +2097,11 @@

Method Details

"statementByteBudget": "A String", # Limit on the number of bytes billed per statement. Exceeding this budget results in an error. "statementTimeoutMs": "A String", # Timeout period for each statement in a script. }, + "secureContext": { # A set of key-value pairs representing the secure context. # Optional. A set of key-value pairs representing the secure context. This can be used to pass sensitive or context-specific information. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "secureParameterEntries": { # Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "a_key": "", # Properties of the object. + }, + }, "systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables. "types": { # Output only. Data type for each system variable. "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } @@ -2325,7 +2344,7 @@

Method Details

], }, "finalExecutionDurationMs": "A String", # Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job. - "globalQueryRemoteRegions": [ # Output only. Regions where the global query accesses data. + "globalQueryRemoteRegions": [ # Output only. The list of remote regions from which a global query accesses data. This field is populated only for parent global query jobs in the primary execution region. It is empty for child global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries). "A String", ], "load": { # Statistics for a load job. # Output only. Statistics for a load job. @@ -2347,7 +2366,7 @@

Method Details

], }, "numChildJobs": "A String", # Output only. Number of child jobs executed. - "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. The global query that created this job. + "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. Reference to the parent global query job, if this is a child global query job. This field is populated only for child global query jobs (remote subqueries or cross-region table copy jobs) executed in remote regions on behalf of a global query. It contains the project ID, job ID, and location of the parent global query job. It is unset for parent global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries). "jobId": "A String", # Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. "location": "A String", # Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations "projectId": "A String", # Required. The ID of the project containing this job. @@ -3120,6 +3139,13 @@

Method Details

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. }, ], + "referencedLogicalViews": [ # Output only. Referenced logical views for the job. + { + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + ], "referencedPropertyGraphs": [ # Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. { # Id path of a property graph. "datasetId": "A String", # Required. The ID of the dataset containing this property graph. @@ -3249,7 +3275,7 @@

Method Details

"sparkJobId": "A String", # Output only. Spark job ID if a Spark job is created successfully. "sparkJobLocation": "A String", # Output only. Location where the Spark job is executed. A location is selected by BigQueury for jobs configured to run in a multi-region. }, - "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. + "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. "timeline": [ # Output only. Describes a timeline of job execution. { # Summary of the state of query execution at a given time. "activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. @@ -3337,7 +3363,7 @@

Method Details

"quotaDeferments": [ # Output only. Quotas which delayed this job's start time. "A String", ], - "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. + "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservations info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. "A String", ], "reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. @@ -3580,6 +3606,7 @@

Method Details

"modelExtractOptions": { # Options related to model extraction. # Optional. Model extract options only applicable when extracting models. "trialId": "A String", # The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](https://cloud.google.com/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning. }, + "nativeGeographyExportEnabled": True or False, # Optional. Applicable to formats: PARQUET. If enabled, BigQuery to Parquet export will write the native Parquet Geography type instead of the default GeoParquet type. "printHeader": true, # Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models. "sourceModel": { # Id path of a model. # A reference to the model being exported. "datasetId": "A String", # Required. The ID of the dataset containing this model. @@ -3846,6 +3873,11 @@

Method Details

"statementByteBudget": "A String", # Limit on the number of bytes billed per statement. Exceeding this budget results in an error. "statementTimeoutMs": "A String", # Timeout period for each statement in a script. }, + "secureContext": { # A set of key-value pairs representing the secure context. # Optional. A set of key-value pairs representing the secure context. This can be used to pass sensitive or context-specific information. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "secureParameterEntries": { # Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "a_key": "", # Properties of the object. + }, + }, "systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables. "types": { # Output only. Data type for each system variable. "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } @@ -4088,7 +4120,7 @@

Method Details

], }, "finalExecutionDurationMs": "A String", # Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job. - "globalQueryRemoteRegions": [ # Output only. Regions where the global query accesses data. + "globalQueryRemoteRegions": [ # Output only. The list of remote regions from which a global query accesses data. This field is populated only for parent global query jobs in the primary execution region. It is empty for child global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries). "A String", ], "load": { # Statistics for a load job. # Output only. Statistics for a load job. @@ -4110,7 +4142,7 @@

Method Details

], }, "numChildJobs": "A String", # Output only. Number of child jobs executed. - "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. The global query that created this job. + "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. Reference to the parent global query job, if this is a child global query job. This field is populated only for child global query jobs (remote subqueries or cross-region table copy jobs) executed in remote regions on behalf of a global query. It contains the project ID, job ID, and location of the parent global query job. It is unset for parent global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries). "jobId": "A String", # Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. "location": "A String", # Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations "projectId": "A String", # Required. The ID of the project containing this job. @@ -4883,6 +4915,13 @@

Method Details

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. }, ], + "referencedLogicalViews": [ # Output only. Referenced logical views for the job. + { + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + ], "referencedPropertyGraphs": [ # Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. { # Id path of a property graph. "datasetId": "A String", # Required. The ID of the dataset containing this property graph. @@ -5012,7 +5051,7 @@

Method Details

"sparkJobId": "A String", # Output only. Spark job ID if a Spark job is created successfully. "sparkJobLocation": "A String", # Output only. Location where the Spark job is executed. A location is selected by BigQueury for jobs configured to run in a multi-region. }, - "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. + "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. "timeline": [ # Output only. Describes a timeline of job execution. { # Summary of the state of query execution at a given time. "activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. @@ -5100,7 +5139,7 @@

Method Details

"quotaDeferments": [ # Output only. Quotas which delayed this job's start time. "A String", ], - "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. + "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservations info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. "A String", ], "reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. @@ -5206,6 +5245,7 @@

Method Details

"modelExtractOptions": { # Options related to model extraction. # Optional. Model extract options only applicable when extracting models. "trialId": "A String", # The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](https://cloud.google.com/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning. }, + "nativeGeographyExportEnabled": True or False, # Optional. Applicable to formats: PARQUET. If enabled, BigQuery to Parquet export will write the native Parquet Geography type instead of the default GeoParquet type. "printHeader": true, # Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models. "sourceModel": { # Id path of a model. # A reference to the model being exported. "datasetId": "A String", # Required. The ID of the dataset containing this model. @@ -5472,6 +5512,11 @@

Method Details

"statementByteBudget": "A String", # Limit on the number of bytes billed per statement. Exceeding this budget results in an error. "statementTimeoutMs": "A String", # Timeout period for each statement in a script. }, + "secureContext": { # A set of key-value pairs representing the secure context. # Optional. A set of key-value pairs representing the secure context. This can be used to pass sensitive or context-specific information. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "secureParameterEntries": { # Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "a_key": "", # Properties of the object. + }, + }, "systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables. "types": { # Output only. Data type for each system variable. "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } @@ -5714,7 +5759,7 @@

Method Details

], }, "finalExecutionDurationMs": "A String", # Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job. - "globalQueryRemoteRegions": [ # Output only. Regions where the global query accesses data. + "globalQueryRemoteRegions": [ # Output only. The list of remote regions from which a global query accesses data. This field is populated only for parent global query jobs in the primary execution region. It is empty for child global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries). "A String", ], "load": { # Statistics for a load job. # Output only. Statistics for a load job. @@ -5736,7 +5781,7 @@

Method Details

], }, "numChildJobs": "A String", # Output only. Number of child jobs executed. - "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. The global query that created this job. + "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. Reference to the parent global query job, if this is a child global query job. This field is populated only for child global query jobs (remote subqueries or cross-region table copy jobs) executed in remote regions on behalf of a global query. It contains the project ID, job ID, and location of the parent global query job. It is unset for parent global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries). "jobId": "A String", # Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. "location": "A String", # Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations "projectId": "A String", # Required. The ID of the project containing this job. @@ -6509,6 +6554,13 @@

Method Details

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. }, ], + "referencedLogicalViews": [ # Output only. Referenced logical views for the job. + { + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + ], "referencedPropertyGraphs": [ # Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. { # Id path of a property graph. "datasetId": "A String", # Required. The ID of the dataset containing this property graph. @@ -6638,7 +6690,7 @@

Method Details

"sparkJobId": "A String", # Output only. Spark job ID if a Spark job is created successfully. "sparkJobLocation": "A String", # Output only. Location where the Spark job is executed. A location is selected by BigQueury for jobs configured to run in a multi-region. }, - "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. + "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. "timeline": [ # Output only. Describes a timeline of job execution. { # Summary of the state of query execution at a given time. "activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. @@ -6726,7 +6778,7 @@

Method Details

"quotaDeferments": [ # Output only. Quotas which delayed this job's start time. "A String", ], - "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. + "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservations info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. "A String", ], "reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. @@ -6855,6 +6907,7 @@

Method Details

"modelExtractOptions": { # Options related to model extraction. # Optional. Model extract options only applicable when extracting models. "trialId": "A String", # The 1-based ID of the trial to be exported from a hyperparameter tuning model. If not specified, the trial with id = [Model](https://cloud.google.com/bigquery/docs/reference/rest/v2/models#resource:-model).defaultTrialId is exported. This field is ignored for models not trained with hyperparameter tuning. }, + "nativeGeographyExportEnabled": True or False, # Optional. Applicable to formats: PARQUET. If enabled, BigQuery to Parquet export will write the native Parquet Geography type instead of the default GeoParquet type. "printHeader": true, # Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models. "sourceModel": { # Id path of a model. # A reference to the model being exported. "datasetId": "A String", # Required. The ID of the dataset containing this model. @@ -7121,6 +7174,11 @@

Method Details

"statementByteBudget": "A String", # Limit on the number of bytes billed per statement. Exceeding this budget results in an error. "statementTimeoutMs": "A String", # Timeout period for each statement in a script. }, + "secureContext": { # A set of key-value pairs representing the secure context. # Optional. A set of key-value pairs representing the secure context. This can be used to pass sensitive or context-specific information. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "secureParameterEntries": { # Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "a_key": "", # Properties of the object. + }, + }, "systemVariables": { # System variables given to a query. # Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. "@@" prefix is not included in the name of the System variables. "types": { # Output only. Data type for each system variable. "a_key": { # The data type of a variable such as a function argument. Examples include: * INT64: `{"typeKind": "INT64"}` * ARRAY: { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "STRING"} } * STRUCT>: { "typeKind": "STRUCT", "structType": { "fields": [ { "name": "x", "type": {"typeKind": "STRING"} }, { "name": "y", "type": { "typeKind": "ARRAY", "arrayElementType": {"typeKind": "DATE"} } } ] } } * RANGE: { "typeKind": "RANGE", "rangeElementType": {"typeKind": "DATE"} } @@ -7365,7 +7423,7 @@

Method Details

], }, "finalExecutionDurationMs": "A String", # Output only. The duration in milliseconds of the execution of the final attempt of this job, as BigQuery may internally re-attempt to execute the job. - "globalQueryRemoteRegions": [ # Output only. Regions where the global query accesses data. + "globalQueryRemoteRegions": [ # Output only. The list of remote regions from which a global query accesses data. This field is populated only for parent global query jobs in the primary execution region. It is empty for child global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries). "A String", ], "load": { # Statistics for a load job. # Output only. Statistics for a load job. @@ -7387,7 +7445,7 @@

Method Details

], }, "numChildJobs": "A String", # Output only. Number of child jobs executed. - "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. The global query that created this job. + "parentGlobalQueryJob": { # A job reference is a fully qualified identifier for referring to a job. # Output only. Reference to the parent global query job, if this is a child global query job. This field is populated only for child global query jobs (remote subqueries or cross-region table copy jobs) executed in remote regions on behalf of a global query. It contains the project ID, job ID, and location of the parent global query job. It is unset for parent global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries). "jobId": "A String", # Required. The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters. "location": "A String", # Optional. The geographic location of the job. The default value is US. For more information about BigQuery locations, see: https://cloud.google.com/bigquery/docs/locations "projectId": "A String", # Required. The ID of the project containing this job. @@ -8160,6 +8218,13 @@

Method Details

"writeRatioMax": 3.14, # Relative amount of time the slowest shard spent on writing output. }, ], + "referencedLogicalViews": [ # Output only. Referenced logical views for the job. + { + "datasetId": "A String", # Required. The ID of the dataset containing this table. + "projectId": "A String", # Required. The ID of the project containing this table. + "tableId": "A String", # Required. The ID of the table. The ID can contain Unicode characters in category L (letter), M (mark), N (number), Pc (connector, including underscore), Pd (dash), and Zs (space). For more information, see [General Category](https://wikipedia.org/wiki/Unicode_character_property#General_Category). The maximum length is 1,024 characters. Certain operations allow suffixing of the table ID with a partition decorator, such as `sample_table$20190123`. + }, + ], "referencedPropertyGraphs": [ # Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list. { # Id path of a property graph. "datasetId": "A String", # Required. The ID of the dataset containing this property graph. @@ -8289,7 +8354,7 @@

Method Details

"sparkJobId": "A String", # Output only. Spark job ID if a Spark job is created successfully. "sparkJobLocation": "A String", # Output only. Location where the Spark job is executed. A location is selected by BigQueury for jobs configured to run in a multi-region. }, - "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. + "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. "timeline": [ # Output only. Describes a timeline of job execution. { # Summary of the state of query execution at a given time. "activeUnits": "A String", # Total number of active workers. This does not correspond directly to slot usage. This is the largest value observed since the last sample. @@ -8377,7 +8442,7 @@

Method Details

"quotaDeferments": [ # Output only. Quotas which delayed this job's start time. "A String", ], - "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. + "reservationGroupPath": [ # Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservations info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group. "A String", ], "reservationUsage": [ # Output only. Job resource usage breakdown by reservation. This field reported misleading information and will no longer be populated. @@ -8536,6 +8601,11 @@

Method Details

"queryResultsFormat": "A String", # Optional. The query results format. If the value is anything other than `STRUCT_ENCODING` or unspecified: * The schema of the results will be provided in `QueryResponse.results_schema` field. * The results of the first page will be provided in `QueryResponse.results` field. * The `QueryResponse.rows` will not be populated. * The `QueryResponse.schema` for `QueryResponse.rows` will also not be populated since it is the schema of the `QueryResponse.rows`. This feature is not yet available. "requestId": "A String", # Optional. A unique user provided identifier to ensure idempotent behavior for queries. Note that this is different from the job_id. It has the following properties: 1. It is case-sensitive, limited to up to 36 ASCII characters. A UUID is recommended. 2. Read only queries can ignore this token since they are nullipotent by definition. 3. For the purposes of idempotency ensured by the request_id, a request is considered duplicate of another only if they have the same request_id and are actually duplicates. When determining whether a request is a duplicate of another request, all parameters in the request that may affect the result are considered. For example, query, connection_properties, query_parameters, use_legacy_sql are parameters that affect the result and are considered when determining whether a request is a duplicate, but properties like timeout_ms don't affect the result and are thus not considered. Dry run query requests are never considered duplicate of another request. 4. When a duplicate mutating query request is detected, it returns: a. the results of the mutation if it completes successfully within the timeout. b. the running operation if it is still in progress at the end of the timeout. 5. Its lifetime is limited to 15 minutes. In other words, if two requests are sent with the same request_id, but more than 15 minutes apart, idempotency is not guaranteed. "reservation": "A String", # Optional. The reservation that jobs.query request would use. User can specify a reservation to execute the job.query. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`. This requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`. + "secureContext": { # A set of key-value pairs representing the secure context. # Optional. A set of key-value pairs representing the secure context. This can be used to pass sensitive or context-specific information. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "secureParameterEntries": { # Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query. + "a_key": "", # Properties of the object. + }, + }, "timeoutMs": 42, # Optional. Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true. "useLegacySql": true, # Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true. If set to false, the query uses BigQuery's [GoogleSQL](https://docs.cloud.google.com/bigquery/docs/introduction-sql). When useLegacySql is set to false, the value of flattenResults is ignored; query will be run as if flattenResults is false. "useQueryCache": true, # Optional. Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever tables in the query are modified. The default value is true. @@ -8665,7 +8735,7 @@

Method Details

"sessionId": "A String", # Output only. The id of the session. }, "startTime": "A String", # Output only. Start time of this query, in milliseconds since the epoch. This field will be present when the query job transitions from the PENDING state to either RUNNING or DONE. - "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. + "statementType": "A String", # Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. "totalBytesBilled": "A String", # Output only. If the project is configured to use on-demand pricing, then this field contains the total bytes billed for the job. If the project is configured to use flat-rate pricing, then you are not billed for bytes and this field is informational only. "totalBytesProcessed": "A String", # The total number of bytes processed for this query. If this query was a dry run, this is the number of bytes that would be processed if the query were run. "totalRows": "A String", # The total number of rows in the complete query result set, which can be more than the number of rows in this single page of results. diff --git a/docs/dyn/bigquery_v2.routines.html b/docs/dyn/bigquery_v2.routines.html index f6275bfe7a..78f8082289 100644 --- a/docs/dyn/bigquery_v2.routines.html +++ b/docs/dyn/bigquery_v2.routines.html @@ -197,6 +197,12 @@

Method Details

"maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. + "volumeMounts": [ # Optional. List of volume mounts for the Python UDF container that executes the managed function. + { # Configuration of a volume mount for the Python UDF container that executes the managed function. + "mountPath": "A String", # Optional. The absolute path within the container where the volume should be mounted. + "sourcePath": "A String", # Optional. The absolute path of the source to be mounted, only support Google Cloud Storage bucket or folder now. Eg: gs://bucket-xxx for Google Cloud Storage bucket, gs://bucket-xxx/folder1/folder2 for Google Cloud Storage folder. + }, + ], }, "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. "A String", @@ -392,6 +398,12 @@

Method Details

"maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. + "volumeMounts": [ # Optional. List of volume mounts for the Python UDF container that executes the managed function. + { # Configuration of a volume mount for the Python UDF container that executes the managed function. + "mountPath": "A String", # Optional. The absolute path within the container where the volume should be mounted. + "sourcePath": "A String", # Optional. The absolute path of the source to be mounted, only support Google Cloud Storage bucket or folder now. Eg: gs://bucket-xxx for Google Cloud Storage bucket, gs://bucket-xxx/folder1/folder2 for Google Cloud Storage folder. + }, + ], }, "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. "A String", @@ -528,6 +540,12 @@

Method Details

"maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. + "volumeMounts": [ # Optional. List of volume mounts for the Python UDF container that executes the managed function. + { # Configuration of a volume mount for the Python UDF container that executes the managed function. + "mountPath": "A String", # Optional. The absolute path within the container where the volume should be mounted. + "sourcePath": "A String", # Optional. The absolute path of the source to be mounted, only support Google Cloud Storage bucket or folder now. Eg: gs://bucket-xxx for Google Cloud Storage bucket, gs://bucket-xxx/folder1/folder2 for Google Cloud Storage folder. + }, + ], }, "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. "A String", @@ -679,6 +697,12 @@

Method Details

"maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. + "volumeMounts": [ # Optional. List of volume mounts for the Python UDF container that executes the managed function. + { # Configuration of a volume mount for the Python UDF container that executes the managed function. + "mountPath": "A String", # Optional. The absolute path within the container where the volume should be mounted. + "sourcePath": "A String", # Optional. The absolute path of the source to be mounted, only support Google Cloud Storage bucket or folder now. Eg: gs://bucket-xxx for Google Cloud Storage bucket, gs://bucket-xxx/folder1/folder2 for Google Cloud Storage folder. + }, + ], }, "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. "A String", @@ -950,6 +974,12 @@

Method Details

"maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. + "volumeMounts": [ # Optional. List of volume mounts for the Python UDF container that executes the managed function. + { # Configuration of a volume mount for the Python UDF container that executes the managed function. + "mountPath": "A String", # Optional. The absolute path within the container where the volume should be mounted. + "sourcePath": "A String", # Optional. The absolute path of the source to be mounted, only support Google Cloud Storage bucket or folder now. Eg: gs://bucket-xxx for Google Cloud Storage bucket, gs://bucket-xxx/folder1/folder2 for Google Cloud Storage folder. + }, + ], }, "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. "A String", @@ -1086,6 +1116,12 @@

Method Details

"maxBatchingRows": "A String", # Optional. Maximum number of rows in each batch sent to the external runtime. If absent or if 0, BigQuery dynamically decides the number of rows in a batch. "runtimeConnection": "A String", # Optional. Fully qualified name of the connection whose service account will be used to execute the code in the container. Format: ```"projects/{project_id}/locations/{location_id}/connections/{connection_id}"``` "runtimeVersion": "A String", # Optional. Language runtime version. Example: `python-3.11`. + "volumeMounts": [ # Optional. List of volume mounts for the Python UDF container that executes the managed function. + { # Configuration of a volume mount for the Python UDF container that executes the managed function. + "mountPath": "A String", # Optional. The absolute path within the container where the volume should be mounted. + "sourcePath": "A String", # Optional. The absolute path of the source to be mounted, only support Google Cloud Storage bucket or folder now. Eg: gs://bucket-xxx for Google Cloud Storage bucket, gs://bucket-xxx/folder1/folder2 for Google Cloud Storage folder. + }, + ], }, "importedLibraries": [ # Optional. If language = "JAVASCRIPT", this field stores the path of the imported JAVASCRIPT libraries. "A String", diff --git a/googleapiclient/discovery_cache/documents/bigquery.v2.json b/googleapiclient/discovery_cache/documents/bigquery.v2.json index d36432e285..d7ac28ad14 100644 --- a/googleapiclient/discovery_cache/documents/bigquery.v2.json +++ b/googleapiclient/discovery_cache/documents/bigquery.v2.json @@ -51,6 +51,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://bigquery.europe-west10.rep.googleapis.com/", +"location": "europe-west10" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://bigquery.europe-west2.rep.googleapis.com/", "location": "europe-west2" }, @@ -2390,7 +2395,7 @@ } } }, -"revision": "20260811", +"revision": "20260922", "rootUrl": "https://bigquery.googleapis.com/", "schemas": { "AggregateClassificationMetrics": { @@ -4864,6 +4869,13 @@ "runtimeVersion": { "description": "Optional. Language runtime version. Example: `python-3.11`.", "type": "string" +}, +"volumeMounts": { +"description": "Optional. List of volume mounts for the Python UDF container that executes the managed function.", +"items": { +"$ref": "ExternalVolumeMount" +}, +"type": "array" } }, "type": "object" @@ -4903,6 +4915,21 @@ }, "type": "object" }, +"ExternalVolumeMount": { +"description": "Configuration of a volume mount for the Python UDF container that executes the managed function.", +"id": "ExternalVolumeMount", +"properties": { +"mountPath": { +"description": "Optional. The absolute path within the container where the volume should be mounted.", +"type": "string" +}, +"sourcePath": { +"description": "Optional. The absolute path of the source to be mounted, only support Google Cloud Storage bucket or folder now. Eg: gs://bucket-xxx for Google Cloud Storage bucket, gs://bucket-xxx/folder1/folder2 for Google Cloud Storage folder.", +"type": "string" +} +}, +"type": "object" +}, "FeatureValue": { "description": "Representative value of a single feature within the cluster.", "id": "FeatureValue", @@ -5926,6 +5953,10 @@ "$ref": "ModelExtractOptions", "description": "Optional. Model extract options only applicable when extracting models." }, +"nativeGeographyExportEnabled": { +"description": "Optional. Applicable to formats: PARQUET. If enabled, BigQuery to Parquet export will write the native Parquet Geography type instead of the default GeoParquet type.", +"type": "boolean" +}, "printHeader": { "default": "true", "description": "Optional. Whether to print out a header row in the results. Default is true. Not applicable when extracting models.", @@ -6307,6 +6338,10 @@ "$ref": "ScriptOptions", "description": "Options controlling the execution of scripts." }, +"secureContext": { +"$ref": "SecureContext", +"description": "Optional. A set of key-value pairs representing the secure context. This can be used to pass sensitive or context-specific information. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query." +}, "systemVariables": { "$ref": "SystemVariables", "description": "Output only. System variables for GoogleSQL queries. A system variable is output if the variable is settable and its value differs from the system default. \"@@\" prefix is not included in the name of the System variables.", @@ -6592,7 +6627,7 @@ "type": "string" }, "globalQueryRemoteRegions": { -"description": "Output only. Regions where the global query accesses data.", +"description": "Output only. The list of remote regions from which a global query accesses data. This field is populated only for parent global query jobs in the primary execution region. It is empty for child global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries).", "items": { "type": "string" }, @@ -6612,7 +6647,7 @@ }, "parentGlobalQueryJob": { "$ref": "JobReference", -"description": "Output only. The global query that created this job.", +"description": "Output only. Reference to the parent global query job, if this is a child global query job. This field is populated only for child global query jobs (remote subqueries or cross-region table copy jobs) executed in remote regions on behalf of a global query. It contains the project ID, job ID, and location of the parent global query job. It is unset for parent global query jobs and single-region queries. For more information, see [Global queries](https://cloud.google.com/bigquery/docs/global-queries).", "readOnly": true }, "parentJobId": { @@ -6634,7 +6669,7 @@ "type": "array" }, "reservationGroupPath": { -"description": "Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservatins info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group.", +"description": "Output only. The reservation group path of the reservation assigned to this job. This field has a limit of 10 nested reservation groups. This is to maintain consistency between reservations info schema and jobs info schema. The first reservation group is the root reservation group and the last is the leaf or lowest level reservation group.", "items": { "type": "string" }, @@ -6879,6 +6914,14 @@ "readOnly": true, "type": "array" }, +"referencedLogicalViews": { +"description": "Output only. Referenced logical views for the job.", +"items": { +"$ref": "TableReference" +}, +"readOnly": true, +"type": "array" +}, "referencedPropertyGraphs": { "description": "Output only. Referenced property graphs for the job. Queries that reference more than 50 property graphs will not have a complete list.", "items": { @@ -6940,7 +6983,7 @@ "readOnly": true }, "statementType": { -"description": "Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement.", +"description": "Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement.", "readOnly": true, "type": "string" }, @@ -8434,6 +8477,10 @@ "description": "Optional. The reservation that jobs.query request would use. User can specify a reservation to execute the job.query. The expected format is `projects/{project}/locations/{location}/reservations/{reservation}`. Forces the query to use on-demand billing when set to `none`. This requires the project or organization to have `reservation_override_mode` set to `ALLOW_ANY_OVERRIDE`.", "type": "string" }, +"secureContext": { +"$ref": "SecureContext", +"description": "Optional. A set of key-value pairs representing the secure context. This can be used to pass sensitive or context-specific information. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query." +}, "timeoutMs": { "description": "Optional. Optional: Specifies the maximum amount of time, in milliseconds, that the client is willing to wait for the query to complete. By default, this limit is 10 seconds (10,000 milliseconds). If the query is complete, the jobComplete field in the response is true. If the query has not yet completed, jobComplete is false. You can request a longer timeout period in the timeoutMs field. However, the call is not guaranteed to wait for the specified timeout; it typically returns after around 200 seconds (200,000 milliseconds), even if the query is not complete. If jobComplete is false, you can continue to wait for the query to complete by calling the getQueryResults method until the jobComplete field in the getQueryResults response is true.", "format": "uint32", @@ -8563,7 +8610,7 @@ "type": "string" }, "statementType": { -"description": "Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION` : [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION` : [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language). * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/other-statements#load_data_statement) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement.", +"description": "Output only. The type of query statement, if valid. Possible values: * `SELECT`: [`SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/query-syntax#select_list) statement. * `ASSERT`: [`ASSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/debugging-statements#assert) statement. * `INSERT`: [`INSERT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#insert_statement) statement. * `UPDATE`: [`UPDATE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#update_statement) statement. * `DELETE`: [`DELETE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `MERGE`: [`MERGE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language) statement. * `TRUNCATE_TABLE`: [`TRUNCATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/dml-syntax#truncate_table_statement) statement. * `CREATE_TABLE`: [`CREATE TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement, without `AS SELECT`. * `CREATE_TABLE_AS_SELECT`: [`CREATE TABLE AS SELECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_statement) statement. * `CREATE_VIEW`: [`CREATE VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_view_statement) statement. * `CREATE_MODEL`: [`CREATE MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-create#create_model_statement) statement. * `CREATE_MATERIALIZED_VIEW`: [`CREATE MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_materialized_view_statement) statement. * `CREATE_FUNCTION`: [`CREATE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_function_statement) statement. * `CREATE_TABLE_FUNCTION`: [`CREATE TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_table_function_statement) statement. * `CREATE_PROCEDURE`: [`CREATE PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_procedure) statement. * `CREATE_ROW_ACCESS_POLICY`: [`CREATE ROW ACCESS POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_row_access_policy_statement) statement. * `CREATE_SCHEMA`: [`CREATE SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_schema_statement) statement. * `CREATE_EXTERNAL_SCHEMA`: [`CREATE EXTERNAL SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_schema_statement) statement. * `CREATE_EXTERNAL_TABLE`: [`CREATE EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_external_table_statement) statement. * `CREATE_SNAPSHOT_TABLE`: [`CREATE SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_snapshot_table_statement) statement. * `CREATE_SEARCH_INDEX`: [`CREATE SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_search_index_statement) statement. * `CREATE_VECTOR_INDEX`: [`CREATE VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_vector_index_statement) statement. * `CREATE_CONNECTION`: [`CREATE CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_connection_statement) statement. * `CREATE_DATA_POLICY`: [`CREATE DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_data_policy_statement) statement. * `CREATE_PROPERTY_GRAPH`: [`CREATE PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_create_graph) statement. * `CREATE_CAPACITY`: [`CREATE CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_capacity_statement) statement. * `CREATE_RESERVATION`: [`CREATE RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_reservation_statement) statement. * `CREATE_ASSIGNMENT`: [`CREATE ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#create_assignment_statement) statement. * `DROP_TABLE`: [`DROP TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_statement) statement. * `DROP_EXTERNAL_TABLE`: [`DROP EXTERNAL TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_external_table_statement) statement. * `DROP_VIEW`: [`DROP VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_view_statement) statement. * `DROP_MODEL`: [`DROP MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-drop-model) statement. * `DROP_MATERIALIZED_VIEW`: [`DROP MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_materialized_view_statement) statement. * `DROP_FUNCTION`: [`DROP FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_function_statement) statement. * `DROP_TABLE_FUNCTION`: [`DROP TABLE FUNCTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_table_function) statement. * `DROP_PROCEDURE`: [`DROP PROCEDURE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_procedure_statement) statement. * `DROP_SEARCH_INDEX`: [`DROP SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_search_index) statement. * `DROP_VECTOR_INDEX`: [`DROP VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_vector_index) statement. * `DROP_SCHEMA`: [`DROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_schema_statement) statement. * `UNDROP_SCHEMA`: [`UNDROP SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#undrop_schema_statement) statement. * `DROP_SNAPSHOT_TABLE`: [`DROP SNAPSHOT TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_snapshot_table_statement) statement. * `DROP_ROW_ACCESS_POLICY`: [`DROP [ALL] ROW ACCESS POLICY|POLICIES`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_row_access_policy_statement) statement. * `DROP_CONNECTION`: [`DROP CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_connection_statement) statement. * `DROP_DATA_POLICY`: [`DROP DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_data_policy) statement. * `DROP_PROPERTY_GRAPH`: [`DROP PROPERTY GRAPH`](https://cloud.google.com/bigquery/docs/reference/standard-sql/graph-schema-statements#gql_drop_graph) statement. * `DROP_CAPACITY`: [`DROP CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_capacity_statement) statement. * `DROP_RESERVATION`: [`DROP RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_reservation_statement) statement. * `DROP_ASSIGNMENT`: [`DROP ASSIGNMENT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#drop_assignment_statement) statement. * `ALTER_TABLE`: [`ALTER TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_table_set_options_statement) statement. * `ALTER_VIEW`: [`ALTER VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_view_set_options_statement) statement. * `ALTER_MATERIALIZED_VIEW`: [`ALTER MATERIALIZED VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_materialized_view_set_options_statement) statement. * `ALTER_SCHEMA`: [`ALTER SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_schema_set_options_statement) statement. * `ALTER_MODEL`: [`ALTER MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-alter-model) statement. * `ALTER_SEARCH_INDEX`: [`ALTER SEARCH INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_search_index_statement) statement. * `ALTER_VECTOR_INDEX`: [`ALTER VECTOR INDEX`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_vector_index_rebuild_statement) statement. * `ALTER_CONNECTION`: [`ALTER CONNECTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_connection_set_options_statement) statement. * `ALTER_DATA_POLICY`: [`ALTER DATA_POLICY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_data_policy_statement) statement. * `ALTER_PROJECT`: [`ALTER PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_project_set_options_statement) statement. * `ALTER_ORGANIZATION`: [`ALTER ORGANIZATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_organization_set_options_statement) statement. * `ALTER_BI_CAPACITY`: [`ALTER BI_CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_bi_capacity_set_options_statement) statement. * `ALTER_CAPACITY`: [`ALTER CAPACITY`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_capacity_set_options_statement) statement. * `ALTER_RESERVATION`: [`ALTER RESERVATION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-definition-language#alter_reservation_set_options_statement) statement. * `SCRIPT`: [`SCRIPT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language) statement. * `CALL`: [`CALL`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#call) statement. * `BEGIN_TRANSACTION`: [`BEGIN TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#begin_transaction) statement. * `COMMIT_TRANSACTION`: [`COMMIT TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#commit_transaction) statement. * `ROLLBACK_TRANSACTION`: [`ROLLBACK TRANSACTION`](https://cloud.google.com/bigquery/docs/reference/standard-sql/procedural-language#rollback_transaction) statement. * `EXPORT_DATA`: [`EXPORT DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/export-statements#export_data_statement) statement. * `EXPORT_MODEL`: [`EXPORT MODEL`](https://cloud.google.com/bigquery-ml/docs/reference/standard-sql/bigqueryml-syntax-export-model) statement. * `EXPORT_METADATA`: [`EXPORT TABLE METADATA`](https://cloud.google.com/bigquery/docs/biglake-iceberg-tables-in-bigquery) statement, for BigLake Iceberg tables. * `LOAD_DATA`: [`LOAD DATA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/load-statements#load_data_statement) statement. * `GRANT_ON_SCHEMA`: [`GRANT ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_TABLE`: [`GRANT ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. Also used for `GRANT ... ON EXTERNAL TABLE`. * `GRANT_ON_VIEW`: [`GRANT ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `GRANT_ON_PROJECT`: [`GRANT ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#grant_statement) statement. * `REVOKE_ON_SCHEMA`: [`REVOKE ... ON SCHEMA`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_TABLE`: [`REVOKE ... ON TABLE`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. Also used for `REVOKE ... ON EXTERNAL TABLE`. * `REVOKE_ON_VIEW`: [`REVOKE ... ON VIEW`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement. * `REVOKE_ON_PROJECT`: [`REVOKE ... ON PROJECT`](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-control-language#revoke_statement) statement.", "readOnly": true, "type": "string" }, @@ -9292,6 +9339,21 @@ }, "type": "object" }, +"SecureContext": { +"description": "A set of key-value pairs representing the secure context.", +"id": "SecureContext", +"properties": { +"secureParameterEntries": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. A set of key-value pairs representing the secure parameter values. They can be retrieved via the SECURE_CONTEXT() function and used to modify the run-time behavior of a query.", +"type": "object" +} +}, +"type": "object" +}, "SerDeInfo": { "description": "Serializer and deserializer information.", "id": "SerDeInfo", @@ -9606,7 +9668,8 @@ "JSON", "ARRAY", "STRUCT", -"RANGE" +"RANGE", +"UUID" ], "enumDescriptions": [ "Invalid type.", @@ -9626,7 +9689,8 @@ "Encoded as a string.", "Encoded as a list with types matching Type.array_type.", "Encoded as a list with fields of type Type.struct_type[i]. List is used because a JSON object cannot have duplicate field names.", -"Encoded as a pair with types matching range_element_type. Pairs must begin with \"[\", end with \")\", and be separated by \", \"." +"Encoded as a pair with types matching range_element_type. Pairs must begin with \"[\", end with \")\", and be separated by \", \".", +"Encoded as a string." ], "type": "string" } From 8c3f7a520a57c904a3360d7221f942d1994aebf0 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:35 +0000 Subject: [PATCH 09/41] feat(bigqueryconnection): update the api #### bigqueryconnection:v1 The following keys were added: - schemas.AwsProperties.properties.crossCloudCacheOptions.$ref (Total Keys: 1) - schemas.AzureProperties.properties.crossCloudCacheOptions.$ref (Total Keys: 1) - schemas.CrossCloudCacheOptions (Total Keys: 3) - schemas.SalesforceDataCloudProperties.properties.crossCloudCacheOptions.$ref (Total Keys: 1) --- ...ion_v1.projects.locations.connections.html | 54 +++++++++++++++++++ .../documents/bigqueryconnection.v1.json | 25 ++++++++- 2 files changed, 78 insertions(+), 1 deletion(-) diff --git a/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html b/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html index 938483e7c3..9cf5457403 100644 --- a/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html +++ b/docs/dyn/bigqueryconnection_v1.projects.locations.connections.html @@ -125,10 +125,16 @@

Method Details

"iamRoleId": "A String", # The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection. "identity": "A String", # A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role. }, + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. "clientId": "A String", # Output only. The client id of the Azure Active Directory Application. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "customerTenantId": "A String", # The id of customer's directory that host the data. "federatedApplicationClientId": "A String", # The client ID of the user's Azure Active Directory Application used for a federated connection. "identity": "A String", # Output only. A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application. @@ -221,6 +227,9 @@

Method Details

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection. "name": "A String", # Output only. The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` "salesforceDataCloud": { # Connection properties specific to Salesforce DataCloud. This is intended for use only by Salesforce partner projects. # Optional. Salesforce DataCloud properties. This field is intended for use only by Salesforce partner projects. This field contains properties for your Salesforce DataCloud connection. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "identity": "A String", # Output only. A unique Google-owned and Google-generated service account identity for the connection. "instanceUri": "A String", # The URL to the user's Salesforce DataCloud instance. "tenantId": "A String", # The ID of the user's Salesforce tenant. @@ -251,10 +260,16 @@

Method Details

"iamRoleId": "A String", # The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection. "identity": "A String", # A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role. }, + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. "clientId": "A String", # Output only. The client id of the Azure Active Directory Application. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "customerTenantId": "A String", # The id of customer's directory that host the data. "federatedApplicationClientId": "A String", # The client ID of the user's Azure Active Directory Application used for a federated connection. "identity": "A String", # Output only. A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application. @@ -347,6 +362,9 @@

Method Details

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection. "name": "A String", # Output only. The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` "salesforceDataCloud": { # Connection properties specific to Salesforce DataCloud. This is intended for use only by Salesforce partner projects. # Optional. Salesforce DataCloud properties. This field is intended for use only by Salesforce partner projects. This field contains properties for your Salesforce DataCloud connection. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "identity": "A String", # Output only. A unique Google-owned and Google-generated service account identity for the connection. "instanceUri": "A String", # The URL to the user's Salesforce DataCloud instance. "tenantId": "A String", # The ID of the user's Salesforce tenant. @@ -401,10 +419,16 @@

Method Details

"iamRoleId": "A String", # The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection. "identity": "A String", # A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role. }, + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. "clientId": "A String", # Output only. The client id of the Azure Active Directory Application. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "customerTenantId": "A String", # The id of customer's directory that host the data. "federatedApplicationClientId": "A String", # The client ID of the user's Azure Active Directory Application used for a federated connection. "identity": "A String", # Output only. A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application. @@ -497,6 +521,9 @@

Method Details

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection. "name": "A String", # Output only. The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` "salesforceDataCloud": { # Connection properties specific to Salesforce DataCloud. This is intended for use only by Salesforce partner projects. # Optional. Salesforce DataCloud properties. This field is intended for use only by Salesforce partner projects. This field contains properties for your Salesforce DataCloud connection. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "identity": "A String", # Output only. A unique Google-owned and Google-generated service account identity for the connection. "instanceUri": "A String", # The URL to the user's Salesforce DataCloud instance. "tenantId": "A String", # The ID of the user's Salesforce tenant. @@ -593,10 +620,16 @@

Method Details

"iamRoleId": "A String", # The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection. "identity": "A String", # A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role. }, + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. "clientId": "A String", # Output only. The client id of the Azure Active Directory Application. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "customerTenantId": "A String", # The id of customer's directory that host the data. "federatedApplicationClientId": "A String", # The client ID of the user's Azure Active Directory Application used for a federated connection. "identity": "A String", # Output only. A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application. @@ -689,6 +722,9 @@

Method Details

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection. "name": "A String", # Output only. The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` "salesforceDataCloud": { # Connection properties specific to Salesforce DataCloud. This is intended for use only by Salesforce partner projects. # Optional. Salesforce DataCloud properties. This field is intended for use only by Salesforce partner projects. This field contains properties for your Salesforce DataCloud connection. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "identity": "A String", # Output only. A unique Google-owned and Google-generated service account identity for the connection. "instanceUri": "A String", # The URL to the user's Salesforce DataCloud instance. "tenantId": "A String", # The ID of the user's Salesforce tenant. @@ -737,10 +773,16 @@

Method Details

"iamRoleId": "A String", # The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection. "identity": "A String", # A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role. }, + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. "clientId": "A String", # Output only. The client id of the Azure Active Directory Application. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "customerTenantId": "A String", # The id of customer's directory that host the data. "federatedApplicationClientId": "A String", # The client ID of the user's Azure Active Directory Application used for a federated connection. "identity": "A String", # Output only. A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application. @@ -833,6 +875,9 @@

Method Details

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection. "name": "A String", # Output only. The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` "salesforceDataCloud": { # Connection properties specific to Salesforce DataCloud. This is intended for use only by Salesforce partner projects. # Optional. Salesforce DataCloud properties. This field is intended for use only by Salesforce partner projects. This field contains properties for your Salesforce DataCloud connection. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "identity": "A String", # Output only. A unique Google-owned and Google-generated service account identity for the connection. "instanceUri": "A String", # The URL to the user's Salesforce DataCloud instance. "tenantId": "A String", # The ID of the user's Salesforce tenant. @@ -863,10 +908,16 @@

Method Details

"iamRoleId": "A String", # The user’s AWS IAM Role that trusts the Google-owned AWS IAM user Connection. "identity": "A String", # A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's AWS IAM Role. }, + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, }, "azure": { # Container for connection properties specific to Azure. # Azure properties. "application": "A String", # Output only. The name of the Azure Active Directory Application. "clientId": "A String", # Output only. The client id of the Azure Active Directory Application. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "customerTenantId": "A String", # The id of customer's directory that host the data. "federatedApplicationClientId": "A String", # The client ID of the user's Azure Active Directory Application used for a federated connection. "identity": "A String", # Output only. A unique Google-owned and Google-generated identity for the Connection. This identity will be used to access the user's Azure Active Directory Application. @@ -959,6 +1010,9 @@

Method Details

"lastModifiedTime": "A String", # Output only. The last update timestamp of the connection. "name": "A String", # Output only. The resource name of the connection in the form of: `projects/{project_id}/locations/{location_id}/connections/{connection_id}` "salesforceDataCloud": { # Connection properties specific to Salesforce DataCloud. This is intended for use only by Salesforce partner projects. # Optional. Salesforce DataCloud properties. This field is intended for use only by Salesforce partner projects. This field contains properties for your Salesforce DataCloud connection. + "crossCloudCacheOptions": { # Options for caching cross-cloud data and metadata files. # Optional. Configuration options for cross-cloud caching of data and metadata files. + "enabled": True or False, # Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled. + }, "identity": "A String", # Output only. A unique Google-owned and Google-generated service account identity for the connection. "instanceUri": "A String", # The URL to the user's Salesforce DataCloud instance. "tenantId": "A String", # The ID of the user's Salesforce tenant. diff --git a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json index 8bc315dc07..0353f1f5bb 100644 --- a/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json +++ b/googleapiclient/discovery_cache/documents/bigqueryconnection.v1.json @@ -366,7 +366,7 @@ } } }, -"revision": "20260804", +"revision": "20260922", "rootUrl": "https://bigqueryconnection.googleapis.com/", "schemas": { "AuditConfig": { @@ -439,6 +439,10 @@ "accessRole": { "$ref": "AwsAccessRole", "description": "Authentication using Google owned service account to assume into customer's AWS IAM Role." +}, +"crossCloudCacheOptions": { +"$ref": "CrossCloudCacheOptions", +"description": "Optional. Configuration options for cross-cloud caching of data and metadata files." } }, "type": "object" @@ -457,6 +461,10 @@ "readOnly": true, "type": "string" }, +"crossCloudCacheOptions": { +"$ref": "CrossCloudCacheOptions", +"description": "Optional. Configuration options for cross-cloud caching of data and metadata files." +}, "customerTenantId": { "description": "The id of customer's directory that host the data.", "type": "string" @@ -902,6 +910,17 @@ }, "type": "object" }, +"CrossCloudCacheOptions": { +"description": "Options for caching cross-cloud data and metadata files.", +"id": "CrossCloudCacheOptions", +"properties": { +"enabled": { +"description": "Optional. Whether cross-cloud caching is enabled. This only affects queries through BigQuery. If this value is `true`, read data and metadata are stored in a cache, which can increase performance and decrease network egress costs for cross-cloud queries. If this value is `false`, cross-cloud caching is disabled.", +"type": "boolean" +} +}, +"type": "object" +}, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", @@ -1018,6 +1037,10 @@ "description": "Connection properties specific to Salesforce DataCloud. This is intended for use only by Salesforce partner projects.", "id": "SalesforceDataCloudProperties", "properties": { +"crossCloudCacheOptions": { +"$ref": "CrossCloudCacheOptions", +"description": "Optional. Configuration options for cross-cloud caching of data and metadata files." +}, "identity": { "description": "Output only. A unique Google-owned and Google-generated service account identity for the connection.", "readOnly": true, From fde66f46d72e98b7e2a84ed6078f8e09889929e3 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:36 +0000 Subject: [PATCH 10/41] feat(billingbudgets): update the api #### billingbudgets:v1 The following keys were added: - schemas.GoogleCloudBillingBudgetsV1Budget.properties.spendCap.$ref (Total Keys: 1) - schemas.GoogleCloudBillingBudgetsV1SpendCap (Total Keys: 7) --- ...ingbudgets_v1.billingAccounts.budgets.html | 330 ++++++++++-------- .../documents/billingbudgets.v1.json | 106 ++++-- 2 files changed, 258 insertions(+), 178 deletions(-) diff --git a/docs/dyn/billingbudgets_v1.billingAccounts.budgets.html b/docs/dyn/billingbudgets_v1.billingAccounts.budgets.html index f54ac60c09..17ea6ea653 100644 --- a/docs/dyn/billingbudgets_v1.billingAccounts.budgets.html +++ b/docs/dyn/billingbudgets_v1.billingAccounts.budgets.html @@ -110,23 +110,23 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period. - "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. - "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. +{ # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met, or pause usage of the specified service when a spend cap budget is enforced). For alerts-only budgets, the budget time period is configurable, with options such as month (default), quarter, year, or custom time period. For spend cap budgets, the budget time period is limited to month. + "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. When `spend_cap` is set, `specified_amount` must be set to a non-negative amount (>= 0); `last_period_amount` is not supported. + "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. Not supported when `spend_cap` is set. }, - "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. + "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. Must be set when `spend_cap` is set; must be non-negative (>= 0). "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, }, - "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. + "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. Must be set when `spend_cap` is set. See `Filter` fields for spend cap restrictions. + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. When `spend_cap` is set, must be `MONTH` (or `usage_period` left unset, which defaults to `MONTH`). `QUARTER` and `YEAR` are not supported for spend caps. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://docs.cloud.google.com/billing/docs/how-to/export-data-bigquery-tables/detailed-usage#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. Not supported when `spend_cap` is set; must be empty. "A String", ], - "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. + "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. Must be set to `EXCLUDE_ALL_CREDITS` when `spend_cap` is set. + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. Not supported when `spend_cap` is set. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -138,41 +138,46 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ + "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ Not supported when `spend_cap` is set; must be empty. "a_key": [ "", ], }, - "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. + "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. Must be set when `spend_cap` is set; must contain exactly one project. "A String", ], - "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. + "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. Not supported when `spend_cap` is set; must be empty. "A String", ], - "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api. + "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://docs.cloud.google.com/billing/v1/how-tos/catalog-api. When `spend_cap` is set, the services filter must be set and must contain exactly one service from this list of eligible services: https://docs.cloud.google.com/billing/docs/how-to/budgets-spend-caps#eligible-services. "A String", ], - "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. + "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. Not supported when `spend_cap` is set; must be empty. "A String", ], }, "displayName": "A String", # User data for display name in UI. The name must be less than or equal to 60 characters. "etag": "A String", # Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes. "name": "A String", # Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. - "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. - "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. - "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. - "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). + "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. Must be set when `spend_cap` is set. For spend caps, `enable_project_level_recipients` must be set to `true`, `disable_default_iam_recipients` must be `false` (or unset), and `pubsub_topic` and `monitoring_notification_channels` must be empty. + "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. Must be `false` (or unset) when `spend_cap` is set; default notifications cannot be disabled for spend caps. + "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. Must be set to `true` when `spend_cap` is set. + "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://docs.cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://docs.cloud.google.com/billing/docs/how-to/send-notifications-to-slack), use a pubsubTopic and configure [programmatic notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). Not supported when `spend_cap` is set; must be empty. "A String", ], - "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). - "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. + "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions). Not supported when `spend_cap` is set; must be empty. + "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format. }, - "ownershipScope": "A String", - "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. - { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). - "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. - "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. + "ownershipScope": "A String", # Optional. When `spend_cap` is set, must be `OWNERSHIP_SCOPE_UNSPECIFIED` or `ALL_USERS`. `BILLING_ACCOUNT` is not supported for spend caps. + "spendCap": { # SpendCap defines the spend cap configuration and state. # Optional. The spend cap configured for this budget. When `spend_cap` is set, strict field restrictions apply to the budget (see field-level comments on `ownership_scope`, `budget_filter`, `amount`, `threshold_rules`, and `notifications_rule`). When `spend_cap.output_state` is `ENFORCED`, only `spend_cap.input_state` can be modified in an `UpdateBudget` request (e.g., setting `input_state` to `AWAITING_NEXT_PERIOD` to lift the cap); modifying any other budget field while enforced will fail with `FAILED_PRECONDITION`. + "inputState": "A String", # Required. The desired state specified by the user. Valid values for mutation: - `CONFIGURED`: Must be set when creating a spend cap (`CreateBudget`). Also valid when updating (`UpdateBudget`) to activate the spend cap. - `AWAITING_NEXT_PERIOD`: Valid only when updating (`UpdateBudget`) to explicitly lift an enforced cap. Supplying any other value will result in an INVALID_ARGUMENT error. + "outputState": "A String", # Output only. The actual resting state of the spend cap. + "reconciling": True or False, # Output only. Indicates whether the server is actively processing a state transition or async workflow. + }, + "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. Must be set when `spend_cap` is set. Spend caps must have exactly three `CURRENT_SPEND` threshold rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). `FORECASTED_SPEND` threshold rules are not supported for spend caps. + { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://docs.cloud.google.com/billing/docs/how-to/budgets#budget-actions). + "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. When `spend_cap` is set on the budget, must be `CURRENT_SPEND` or `BASIS_UNSPECIFIED`. `FORECASTED_SPEND` is not supported. + "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. When `spend_cap` is set on the budget, `threshold_rules` must contain exactly three rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). }, ], } @@ -185,23 +190,23 @@

Method Details

Returns: An object of the form: - { # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period. - "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. - "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. + { # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met, or pause usage of the specified service when a spend cap budget is enforced). For alerts-only budgets, the budget time period is configurable, with options such as month (default), quarter, year, or custom time period. For spend cap budgets, the budget time period is limited to month. + "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. When `spend_cap` is set, `specified_amount` must be set to a non-negative amount (>= 0); `last_period_amount` is not supported. + "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. Not supported when `spend_cap` is set. }, - "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. + "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. Must be set when `spend_cap` is set; must be non-negative (>= 0). "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, }, - "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. + "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. Must be set when `spend_cap` is set. See `Filter` fields for spend cap restrictions. + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. When `spend_cap` is set, must be `MONTH` (or `usage_period` left unset, which defaults to `MONTH`). `QUARTER` and `YEAR` are not supported for spend caps. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://docs.cloud.google.com/billing/docs/how-to/export-data-bigquery-tables/detailed-usage#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. Not supported when `spend_cap` is set; must be empty. "A String", ], - "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. + "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. Must be set to `EXCLUDE_ALL_CREDITS` when `spend_cap` is set. + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. Not supported when `spend_cap` is set. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -213,41 +218,46 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ + "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ Not supported when `spend_cap` is set; must be empty. "a_key": [ "", ], }, - "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. + "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. Must be set when `spend_cap` is set; must contain exactly one project. "A String", ], - "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. + "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. Not supported when `spend_cap` is set; must be empty. "A String", ], - "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api. + "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://docs.cloud.google.com/billing/v1/how-tos/catalog-api. When `spend_cap` is set, the services filter must be set and must contain exactly one service from this list of eligible services: https://docs.cloud.google.com/billing/docs/how-to/budgets-spend-caps#eligible-services. "A String", ], - "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. + "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. Not supported when `spend_cap` is set; must be empty. "A String", ], }, "displayName": "A String", # User data for display name in UI. The name must be less than or equal to 60 characters. "etag": "A String", # Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes. "name": "A String", # Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. - "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. - "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. - "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. - "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). + "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. Must be set when `spend_cap` is set. For spend caps, `enable_project_level_recipients` must be set to `true`, `disable_default_iam_recipients` must be `false` (or unset), and `pubsub_topic` and `monitoring_notification_channels` must be empty. + "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. Must be `false` (or unset) when `spend_cap` is set; default notifications cannot be disabled for spend caps. + "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. Must be set to `true` when `spend_cap` is set. + "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://docs.cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://docs.cloud.google.com/billing/docs/how-to/send-notifications-to-slack), use a pubsubTopic and configure [programmatic notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). Not supported when `spend_cap` is set; must be empty. "A String", ], - "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). - "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. + "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions). Not supported when `spend_cap` is set; must be empty. + "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format. + }, + "ownershipScope": "A String", # Optional. When `spend_cap` is set, must be `OWNERSHIP_SCOPE_UNSPECIFIED` or `ALL_USERS`. `BILLING_ACCOUNT` is not supported for spend caps. + "spendCap": { # SpendCap defines the spend cap configuration and state. # Optional. The spend cap configured for this budget. When `spend_cap` is set, strict field restrictions apply to the budget (see field-level comments on `ownership_scope`, `budget_filter`, `amount`, `threshold_rules`, and `notifications_rule`). When `spend_cap.output_state` is `ENFORCED`, only `spend_cap.input_state` can be modified in an `UpdateBudget` request (e.g., setting `input_state` to `AWAITING_NEXT_PERIOD` to lift the cap); modifying any other budget field while enforced will fail with `FAILED_PRECONDITION`. + "inputState": "A String", # Required. The desired state specified by the user. Valid values for mutation: - `CONFIGURED`: Must be set when creating a spend cap (`CreateBudget`). Also valid when updating (`UpdateBudget`) to activate the spend cap. - `AWAITING_NEXT_PERIOD`: Valid only when updating (`UpdateBudget`) to explicitly lift an enforced cap. Supplying any other value will result in an INVALID_ARGUMENT error. + "outputState": "A String", # Output only. The actual resting state of the spend cap. + "reconciling": True or False, # Output only. Indicates whether the server is actively processing a state transition or async workflow. }, - "ownershipScope": "A String", - "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. - { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). - "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. - "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. + "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. Must be set when `spend_cap` is set. Spend caps must have exactly three `CURRENT_SPEND` threshold rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). `FORECASTED_SPEND` threshold rules are not supported for spend caps. + { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://docs.cloud.google.com/billing/docs/how-to/budgets#budget-actions). + "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. When `spend_cap` is set on the budget, must be `CURRENT_SPEND` or `BASIS_UNSPECIFIED`. `FORECASTED_SPEND` is not supported. + "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. When `spend_cap` is set on the budget, `threshold_rules` must contain exactly three rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). }, ], }
@@ -285,23 +295,23 @@

Method Details

Returns: An object of the form: - { # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period. - "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. - "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. + { # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met, or pause usage of the specified service when a spend cap budget is enforced). For alerts-only budgets, the budget time period is configurable, with options such as month (default), quarter, year, or custom time period. For spend cap budgets, the budget time period is limited to month. + "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. When `spend_cap` is set, `specified_amount` must be set to a non-negative amount (>= 0); `last_period_amount` is not supported. + "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. Not supported when `spend_cap` is set. }, - "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. + "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. Must be set when `spend_cap` is set; must be non-negative (>= 0). "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, }, - "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. + "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. Must be set when `spend_cap` is set. See `Filter` fields for spend cap restrictions. + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. When `spend_cap` is set, must be `MONTH` (or `usage_period` left unset, which defaults to `MONTH`). `QUARTER` and `YEAR` are not supported for spend caps. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://docs.cloud.google.com/billing/docs/how-to/export-data-bigquery-tables/detailed-usage#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. Not supported when `spend_cap` is set; must be empty. "A String", ], - "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. + "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. Must be set to `EXCLUDE_ALL_CREDITS` when `spend_cap` is set. + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. Not supported when `spend_cap` is set. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -313,41 +323,46 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ + "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ Not supported when `spend_cap` is set; must be empty. "a_key": [ "", ], }, - "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. + "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. Must be set when `spend_cap` is set; must contain exactly one project. "A String", ], - "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. + "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. Not supported when `spend_cap` is set; must be empty. "A String", ], - "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api. + "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://docs.cloud.google.com/billing/v1/how-tos/catalog-api. When `spend_cap` is set, the services filter must be set and must contain exactly one service from this list of eligible services: https://docs.cloud.google.com/billing/docs/how-to/budgets-spend-caps#eligible-services. "A String", ], - "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. + "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. Not supported when `spend_cap` is set; must be empty. "A String", ], }, "displayName": "A String", # User data for display name in UI. The name must be less than or equal to 60 characters. "etag": "A String", # Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes. "name": "A String", # Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. - "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. - "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. - "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. - "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). + "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. Must be set when `spend_cap` is set. For spend caps, `enable_project_level_recipients` must be set to `true`, `disable_default_iam_recipients` must be `false` (or unset), and `pubsub_topic` and `monitoring_notification_channels` must be empty. + "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. Must be `false` (or unset) when `spend_cap` is set; default notifications cannot be disabled for spend caps. + "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. Must be set to `true` when `spend_cap` is set. + "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://docs.cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://docs.cloud.google.com/billing/docs/how-to/send-notifications-to-slack), use a pubsubTopic and configure [programmatic notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). Not supported when `spend_cap` is set; must be empty. "A String", ], - "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). - "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. + "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions). Not supported when `spend_cap` is set; must be empty. + "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format. + }, + "ownershipScope": "A String", # Optional. When `spend_cap` is set, must be `OWNERSHIP_SCOPE_UNSPECIFIED` or `ALL_USERS`. `BILLING_ACCOUNT` is not supported for spend caps. + "spendCap": { # SpendCap defines the spend cap configuration and state. # Optional. The spend cap configured for this budget. When `spend_cap` is set, strict field restrictions apply to the budget (see field-level comments on `ownership_scope`, `budget_filter`, `amount`, `threshold_rules`, and `notifications_rule`). When `spend_cap.output_state` is `ENFORCED`, only `spend_cap.input_state` can be modified in an `UpdateBudget` request (e.g., setting `input_state` to `AWAITING_NEXT_PERIOD` to lift the cap); modifying any other budget field while enforced will fail with `FAILED_PRECONDITION`. + "inputState": "A String", # Required. The desired state specified by the user. Valid values for mutation: - `CONFIGURED`: Must be set when creating a spend cap (`CreateBudget`). Also valid when updating (`UpdateBudget`) to activate the spend cap. - `AWAITING_NEXT_PERIOD`: Valid only when updating (`UpdateBudget`) to explicitly lift an enforced cap. Supplying any other value will result in an INVALID_ARGUMENT error. + "outputState": "A String", # Output only. The actual resting state of the spend cap. + "reconciling": True or False, # Output only. Indicates whether the server is actively processing a state transition or async workflow. }, - "ownershipScope": "A String", - "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. - { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). - "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. - "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. + "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. Must be set when `spend_cap` is set. Spend caps must have exactly three `CURRENT_SPEND` threshold rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). `FORECASTED_SPEND` threshold rules are not supported for spend caps. + { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://docs.cloud.google.com/billing/docs/how-to/budgets#budget-actions). + "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. When `spend_cap` is set on the budget, must be `CURRENT_SPEND` or `BASIS_UNSPECIFIED`. `FORECASTED_SPEND` is not supported. + "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. When `spend_cap` is set on the budget, `threshold_rules` must contain exactly three rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). }, ], } @@ -372,23 +387,23 @@

Method Details

{ # Response for ListBudgets "budgets": [ # List of the budgets owned by the requested billing account. - { # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period. - "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. - "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. + { # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met, or pause usage of the specified service when a spend cap budget is enforced). For alerts-only budgets, the budget time period is configurable, with options such as month (default), quarter, year, or custom time period. For spend cap budgets, the budget time period is limited to month. + "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. When `spend_cap` is set, `specified_amount` must be set to a non-negative amount (>= 0); `last_period_amount` is not supported. + "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. Not supported when `spend_cap` is set. }, - "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. + "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. Must be set when `spend_cap` is set; must be non-negative (>= 0). "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, }, - "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. + "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. Must be set when `spend_cap` is set. See `Filter` fields for spend cap restrictions. + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. When `spend_cap` is set, must be `MONTH` (or `usage_period` left unset, which defaults to `MONTH`). `QUARTER` and `YEAR` are not supported for spend caps. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://docs.cloud.google.com/billing/docs/how-to/export-data-bigquery-tables/detailed-usage#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. Not supported when `spend_cap` is set; must be empty. "A String", ], - "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. + "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. Must be set to `EXCLUDE_ALL_CREDITS` when `spend_cap` is set. + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. Not supported when `spend_cap` is set. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -400,41 +415,46 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ + "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ Not supported when `spend_cap` is set; must be empty. "a_key": [ "", ], }, - "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. + "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. Must be set when `spend_cap` is set; must contain exactly one project. "A String", ], - "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. + "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. Not supported when `spend_cap` is set; must be empty. "A String", ], - "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api. + "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://docs.cloud.google.com/billing/v1/how-tos/catalog-api. When `spend_cap` is set, the services filter must be set and must contain exactly one service from this list of eligible services: https://docs.cloud.google.com/billing/docs/how-to/budgets-spend-caps#eligible-services. "A String", ], - "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. + "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. Not supported when `spend_cap` is set; must be empty. "A String", ], }, "displayName": "A String", # User data for display name in UI. The name must be less than or equal to 60 characters. "etag": "A String", # Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes. "name": "A String", # Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. - "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. - "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. - "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. - "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). + "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. Must be set when `spend_cap` is set. For spend caps, `enable_project_level_recipients` must be set to `true`, `disable_default_iam_recipients` must be `false` (or unset), and `pubsub_topic` and `monitoring_notification_channels` must be empty. + "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. Must be `false` (or unset) when `spend_cap` is set; default notifications cannot be disabled for spend caps. + "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. Must be set to `true` when `spend_cap` is set. + "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://docs.cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://docs.cloud.google.com/billing/docs/how-to/send-notifications-to-slack), use a pubsubTopic and configure [programmatic notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). Not supported when `spend_cap` is set; must be empty. "A String", ], - "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). - "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. + "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions). Not supported when `spend_cap` is set; must be empty. + "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format. }, - "ownershipScope": "A String", - "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. - { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). - "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. - "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. + "ownershipScope": "A String", # Optional. When `spend_cap` is set, must be `OWNERSHIP_SCOPE_UNSPECIFIED` or `ALL_USERS`. `BILLING_ACCOUNT` is not supported for spend caps. + "spendCap": { # SpendCap defines the spend cap configuration and state. # Optional. The spend cap configured for this budget. When `spend_cap` is set, strict field restrictions apply to the budget (see field-level comments on `ownership_scope`, `budget_filter`, `amount`, `threshold_rules`, and `notifications_rule`). When `spend_cap.output_state` is `ENFORCED`, only `spend_cap.input_state` can be modified in an `UpdateBudget` request (e.g., setting `input_state` to `AWAITING_NEXT_PERIOD` to lift the cap); modifying any other budget field while enforced will fail with `FAILED_PRECONDITION`. + "inputState": "A String", # Required. The desired state specified by the user. Valid values for mutation: - `CONFIGURED`: Must be set when creating a spend cap (`CreateBudget`). Also valid when updating (`UpdateBudget`) to activate the spend cap. - `AWAITING_NEXT_PERIOD`: Valid only when updating (`UpdateBudget`) to explicitly lift an enforced cap. Supplying any other value will result in an INVALID_ARGUMENT error. + "outputState": "A String", # Output only. The actual resting state of the spend cap. + "reconciling": True or False, # Output only. Indicates whether the server is actively processing a state transition or async workflow. + }, + "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. Must be set when `spend_cap` is set. Spend caps must have exactly three `CURRENT_SPEND` threshold rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). `FORECASTED_SPEND` threshold rules are not supported for spend caps. + { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://docs.cloud.google.com/billing/docs/how-to/budgets#budget-actions). + "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. When `spend_cap` is set on the budget, must be `CURRENT_SPEND` or `BASIS_UNSPECIFIED`. `FORECASTED_SPEND` is not supported. + "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. When `spend_cap` is set on the budget, `threshold_rules` must contain exactly three rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). }, ], }, @@ -466,23 +486,23 @@

Method Details

body: object, The request body. The object takes the form of: -{ # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period. - "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. - "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. +{ # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met, or pause usage of the specified service when a spend cap budget is enforced). For alerts-only budgets, the budget time period is configurable, with options such as month (default), quarter, year, or custom time period. For spend cap budgets, the budget time period is limited to month. + "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. When `spend_cap` is set, `specified_amount` must be set to a non-negative amount (>= 0); `last_period_amount` is not supported. + "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. Not supported when `spend_cap` is set. }, - "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. + "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. Must be set when `spend_cap` is set; must be non-negative (>= 0). "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, }, - "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. + "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. Must be set when `spend_cap` is set. See `Filter` fields for spend cap restrictions. + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. When `spend_cap` is set, must be `MONTH` (or `usage_period` left unset, which defaults to `MONTH`). `QUARTER` and `YEAR` are not supported for spend caps. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://docs.cloud.google.com/billing/docs/how-to/export-data-bigquery-tables/detailed-usage#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. Not supported when `spend_cap` is set; must be empty. "A String", ], - "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. + "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. Must be set to `EXCLUDE_ALL_CREDITS` when `spend_cap` is set. + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. Not supported when `spend_cap` is set. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -494,41 +514,46 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ + "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ Not supported when `spend_cap` is set; must be empty. "a_key": [ "", ], }, - "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. + "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. Must be set when `spend_cap` is set; must contain exactly one project. "A String", ], - "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. + "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. Not supported when `spend_cap` is set; must be empty. "A String", ], - "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api. + "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://docs.cloud.google.com/billing/v1/how-tos/catalog-api. When `spend_cap` is set, the services filter must be set and must contain exactly one service from this list of eligible services: https://docs.cloud.google.com/billing/docs/how-to/budgets-spend-caps#eligible-services. "A String", ], - "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. + "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. Not supported when `spend_cap` is set; must be empty. "A String", ], }, "displayName": "A String", # User data for display name in UI. The name must be less than or equal to 60 characters. "etag": "A String", # Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes. "name": "A String", # Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. - "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. - "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. - "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. - "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). + "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. Must be set when `spend_cap` is set. For spend caps, `enable_project_level_recipients` must be set to `true`, `disable_default_iam_recipients` must be `false` (or unset), and `pubsub_topic` and `monitoring_notification_channels` must be empty. + "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. Must be `false` (or unset) when `spend_cap` is set; default notifications cannot be disabled for spend caps. + "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. Must be set to `true` when `spend_cap` is set. + "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://docs.cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://docs.cloud.google.com/billing/docs/how-to/send-notifications-to-slack), use a pubsubTopic and configure [programmatic notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). Not supported when `spend_cap` is set; must be empty. "A String", ], - "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). - "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. + "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions). Not supported when `spend_cap` is set; must be empty. + "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format. + }, + "ownershipScope": "A String", # Optional. When `spend_cap` is set, must be `OWNERSHIP_SCOPE_UNSPECIFIED` or `ALL_USERS`. `BILLING_ACCOUNT` is not supported for spend caps. + "spendCap": { # SpendCap defines the spend cap configuration and state. # Optional. The spend cap configured for this budget. When `spend_cap` is set, strict field restrictions apply to the budget (see field-level comments on `ownership_scope`, `budget_filter`, `amount`, `threshold_rules`, and `notifications_rule`). When `spend_cap.output_state` is `ENFORCED`, only `spend_cap.input_state` can be modified in an `UpdateBudget` request (e.g., setting `input_state` to `AWAITING_NEXT_PERIOD` to lift the cap); modifying any other budget field while enforced will fail with `FAILED_PRECONDITION`. + "inputState": "A String", # Required. The desired state specified by the user. Valid values for mutation: - `CONFIGURED`: Must be set when creating a spend cap (`CreateBudget`). Also valid when updating (`UpdateBudget`) to activate the spend cap. - `AWAITING_NEXT_PERIOD`: Valid only when updating (`UpdateBudget`) to explicitly lift an enforced cap. Supplying any other value will result in an INVALID_ARGUMENT error. + "outputState": "A String", # Output only. The actual resting state of the spend cap. + "reconciling": True or False, # Output only. Indicates whether the server is actively processing a state transition or async workflow. }, - "ownershipScope": "A String", - "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. - { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). - "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. - "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. + "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. Must be set when `spend_cap` is set. Spend caps must have exactly three `CURRENT_SPEND` threshold rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). `FORECASTED_SPEND` threshold rules are not supported for spend caps. + { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://docs.cloud.google.com/billing/docs/how-to/budgets#budget-actions). + "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. When `spend_cap` is set on the budget, must be `CURRENT_SPEND` or `BASIS_UNSPECIFIED`. `FORECASTED_SPEND` is not supported. + "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. When `spend_cap` is set on the budget, `threshold_rules` must contain exactly three rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). }, ], } @@ -542,23 +567,23 @@

Method Details

Returns: An object of the form: - { # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period. - "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. - "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. + { # A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met, or pause usage of the specified service when a spend cap budget is enforced). For alerts-only budgets, the budget time period is configurable, with options such as month (default), quarter, year, or custom time period. For spend cap budgets, the budget time period is limited to month. + "amount": { # The budgeted amount for each usage period. # Required. Budgeted amount. When `spend_cap` is set, `specified_amount` must be set to a non-negative amount (>= 0); `last_period_amount` is not supported. + "lastPeriodAmount": { # Describes a budget amount targeted to the last Filter.calendar_period spend. At this time, the amount is automatically 100% of the last calendar period's spend; that is, there are no other options yet. LastPeriodAmount cannot be set for a budget configured with a Filter.custom_period. # Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. Not supported when `spend_cap` is set. }, - "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. + "specifiedAmount": { # Represents an amount of money with its currency type. # A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. Must be set when `spend_cap` is set; must be non-negative (>= 0). "currencyCode": "A String", # The three-letter currency code defined in ISO 4217. "nanos": 42, # Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If `units` is positive, `nanos` must be positive or zero. If `units` is zero, `nanos` can be positive, zero, or negative. If `units` is negative, `nanos` must be negative or zero. For example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000. "units": "A String", # The whole units of the amount. For example if `currencyCode` is `"USD"`, then 1 unit is one US dollar. }, }, - "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. - "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. - "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. + "budgetFilter": { # A filter for a budget, limiting the scope of the cost to calculate. # Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. Must be set when `spend_cap` is set. See `Filter` fields for spend cap restrictions. + "calendarPeriod": "A String", # Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. When `spend_cap` is set, must be `MONTH` (or `usage_period` left unset, which defaults to `MONTH`). `QUARTER` and `YEAR` are not supported for spend caps. + "creditTypes": [ # Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://docs.cloud.google.com/billing/docs/how-to/export-data-bigquery-tables/detailed-usage#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. Not supported when `spend_cap` is set; must be empty. "A String", ], - "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. - "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. + "creditTypesTreatment": "A String", # Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. Must be set to `EXCLUDE_ALL_CREDITS` when `spend_cap` is set. + "customPeriod": { # All date times begin at 12 AM US and Canadian Pacific Time (UTC-8). # Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. Not supported when `spend_cap` is set. "endDate": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Optional. The end date of the time period. Budgets with elapsed end date won't be processed. If unset, specifies to track all usage incurred since the start_date. "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. @@ -570,41 +595,46 @@

Method Details

"year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. }, }, - "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ + "labels": { # Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `"key": value` pair. Example: `{ "name": "wrench" }`. _Currently, multiple entries or multiple values per entry are not allowed._ Not supported when `spend_cap` is set; must be empty. "a_key": [ "", ], }, - "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. + "projects": [ # Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. Must be set when `spend_cap` is set; must contain exactly one project. "A String", ], - "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. + "resourceAncestors": [ # Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. Not supported when `spend_cap` is set; must be empty. "A String", ], - "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api. + "services": [ # Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://docs.cloud.google.com/billing/v1/how-tos/catalog-api. When `spend_cap` is set, the services filter must be set and must contain exactly one service from this list of eligible services: https://docs.cloud.google.com/billing/docs/how-to/budgets-spend-caps#eligible-services. "A String", ], - "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. + "subaccounts": [ # Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. Not supported when `spend_cap` is set; must be empty. "A String", ], }, "displayName": "A String", # User data for display name in UI. The name must be less than or equal to 60 characters. "etag": "A String", # Optional. Etag to validate that the object is unchanged for a read-modify-write operation. An empty etag causes an update to overwrite other changes. "name": "A String", # Output only. Resource name of the budget. The resource name implies the scope of a budget. Values are of the form `billingAccounts/{billingAccountId}/budgets/{budgetId}`. - "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. - "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. - "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. - "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). + "notificationsRule": { # NotificationsRule defines notifications that are sent based on budget spend and thresholds. # Optional. Rules to apply to notifications sent based on budget spend and thresholds. Must be set when `spend_cap` is set. For spend caps, `enable_project_level_recipients` must be set to `true`, `disable_default_iam_recipients` must be `false` (or unset), and `pubsub_topic` and `monitoring_notification_channels` must be empty. + "disableDefaultIamRecipients": True or False, # Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. Must be `false` (or unset) when `spend_cap` is set; default notifications cannot be disabled for spend caps. + "enableProjectLevelRecipients": True or False, # Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. Must be set to `true` when `spend_cap` is set. + "monitoringNotificationChannels": [ # Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://docs.cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://docs.cloud.google.com/billing/docs/how-to/send-notifications-to-slack), use a pubsubTopic and configure [programmatic notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). Not supported when `spend_cap` is set; must be empty. "A String", ], - "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task). - "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format. + "pubsubTopic": "A String", # Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions). Not supported when `spend_cap` is set; must be empty. + "schemaVersion": "A String", # Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only "1.0" is accepted. It represents the JSON schema as defined in https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format. + }, + "ownershipScope": "A String", # Optional. When `spend_cap` is set, must be `OWNERSHIP_SCOPE_UNSPECIFIED` or `ALL_USERS`. `BILLING_ACCOUNT` is not supported for spend caps. + "spendCap": { # SpendCap defines the spend cap configuration and state. # Optional. The spend cap configured for this budget. When `spend_cap` is set, strict field restrictions apply to the budget (see field-level comments on `ownership_scope`, `budget_filter`, `amount`, `threshold_rules`, and `notifications_rule`). When `spend_cap.output_state` is `ENFORCED`, only `spend_cap.input_state` can be modified in an `UpdateBudget` request (e.g., setting `input_state` to `AWAITING_NEXT_PERIOD` to lift the cap); modifying any other budget field while enforced will fail with `FAILED_PRECONDITION`. + "inputState": "A String", # Required. The desired state specified by the user. Valid values for mutation: - `CONFIGURED`: Must be set when creating a spend cap (`CreateBudget`). Also valid when updating (`UpdateBudget`) to activate the spend cap. - `AWAITING_NEXT_PERIOD`: Valid only when updating (`UpdateBudget`) to explicitly lift an enforced cap. Supplying any other value will result in an INVALID_ARGUMENT error. + "outputState": "A String", # Output only. The actual resting state of the spend cap. + "reconciling": True or False, # Output only. Indicates whether the server is actively processing a state transition or async workflow. }, - "ownershipScope": "A String", - "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. - { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions). - "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. - "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. + "thresholdRules": [ # Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. Must be set when `spend_cap` is set. Spend caps must have exactly three `CURRENT_SPEND` threshold rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). `FORECASTED_SPEND` threshold rules are not supported for spend caps. + { # ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://docs.cloud.google.com/billing/docs/how-to/budgets#budget-actions). + "spendBasis": "A String", # Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. When `spend_cap` is set on the budget, must be `CURRENT_SPEND` or `BASIS_UNSPECIFIED`. `FORECASTED_SPEND` is not supported. + "thresholdPercent": 3.14, # Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. When `spend_cap` is set on the budget, `threshold_rules` must contain exactly three rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). }, ], } diff --git a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json index 13cf687df9..11a805ed19 100644 --- a/googleapiclient/discovery_cache/documents/billingbudgets.v1.json +++ b/googleapiclient/discovery_cache/documents/billingbudgets.v1.json @@ -275,20 +275,20 @@ } } }, -"revision": "20240707", +"revision": "20260928", "rootUrl": "https://billingbudgets.googleapis.com/", "schemas": { "GoogleCloudBillingBudgetsV1Budget": { -"description": "A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met). The budget time period is configurable, with options such as month (default), quarter, year, or custom time period.", +"description": "A budget is a plan that describes what you expect to spend on Cloud projects, plus the rules to execute as spend is tracked against that plan, (for example, send an alert when 90% of the target spend is met, or pause usage of the specified service when a spend cap budget is enforced). For alerts-only budgets, the budget time period is configurable, with options such as month (default), quarter, year, or custom time period. For spend cap budgets, the budget time period is limited to month.", "id": "GoogleCloudBillingBudgetsV1Budget", "properties": { "amount": { "$ref": "GoogleCloudBillingBudgetsV1BudgetAmount", -"description": "Required. Budgeted amount." +"description": "Required. Budgeted amount. When `spend_cap` is set, `specified_amount` must be set to a non-negative amount (>= 0); `last_period_amount` is not supported." }, "budgetFilter": { "$ref": "GoogleCloudBillingBudgetsV1Filter", -"description": "Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters." +"description": "Optional. Filters that define which resources are used to compute the actual spend against the budget amount, such as projects, services, and the budget's time period, as well as other filters. Must be set when `spend_cap` is set. See `Filter` fields for spend cap restrictions." }, "displayName": { "description": "User data for display name in UI. The name must be less than or equal to 60 characters.", @@ -305,9 +305,10 @@ }, "notificationsRule": { "$ref": "GoogleCloudBillingBudgetsV1NotificationsRule", -"description": "Optional. Rules to apply to notifications sent based on budget spend and thresholds." +"description": "Optional. Rules to apply to notifications sent based on budget spend and thresholds. Must be set when `spend_cap` is set. For spend caps, `enable_project_level_recipients` must be set to `true`, `disable_default_iam_recipients` must be `false` (or unset), and `pubsub_topic` and `monitoring_notification_channels` must be empty." }, "ownershipScope": { +"description": "Optional. When `spend_cap` is set, must be `OWNERSHIP_SCOPE_UNSPECIFIED` or `ALL_USERS`. `BILLING_ACCOUNT` is not supported for spend caps.", "enum": [ "OWNERSHIP_SCOPE_UNSPECIFIED", "ALL_USERS", @@ -316,12 +317,16 @@ "enumDescriptions": [ "Unspecified ownership scope, same as ALL_USERS.", "Both billing account-level users and project-level users have full access to the budget, if the users have the required IAM permissions.", -"Only billing account-level users have full access to the budget. Project-level users have read-only access, even if they have the required IAM permissions." +"Only billing account-level users have full access to the budget. Project-level users have read-only access, even if they have the required IAM permissions. Not supported when `spend_cap` is set." ], "type": "string" }, +"spendCap": { +"$ref": "GoogleCloudBillingBudgetsV1SpendCap", +"description": "Optional. The spend cap configured for this budget. When `spend_cap` is set, strict field restrictions apply to the budget (see field-level comments on `ownership_scope`, `budget_filter`, `amount`, `threshold_rules`, and `notifications_rule`). When `spend_cap.output_state` is `ENFORCED`, only `spend_cap.input_state` can be modified in an `UpdateBudget` request (e.g., setting `input_state` to `AWAITING_NEXT_PERIOD` to lift the cap); modifying any other budget field while enforced will fail with `FAILED_PRECONDITION`." +}, "thresholdRules": { -"description": "Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications.", +"description": "Optional. Rules that trigger alerts (notifications of thresholds being crossed) when spend exceeds the specified percentages of the budget. Optional for `pubsubTopic` notifications. Required if using email notifications. Must be set when `spend_cap` is set. Spend caps must have exactly three `CURRENT_SPEND` threshold rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%). `FORECASTED_SPEND` threshold rules are not supported for spend caps.", "items": { "$ref": "GoogleCloudBillingBudgetsV1ThresholdRule" }, @@ -336,11 +341,11 @@ "properties": { "lastPeriodAmount": { "$ref": "GoogleCloudBillingBudgetsV1LastPeriodAmount", -"description": "Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period." +"description": "Use the last period's actual spend as the budget for the present period. LastPeriodAmount can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. Not supported when `spend_cap` is set." }, "specifiedAmount": { "$ref": "GoogleTypeMoney", -"description": "A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output." +"description": "A specified amount to use as the budget. `currency_code` is optional. If specified when creating a budget, it must match the currency of the billing account. If specified when updating a budget, it must match the currency_code of the existing budget. The `currency_code` is provided on output. Must be set when `spend_cap` is set; must be non-negative (>= 0)." } }, "type": "object" @@ -365,7 +370,7 @@ "id": "GoogleCloudBillingBudgetsV1Filter", "properties": { "calendarPeriod": { -"description": "Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on.", +"description": "Optional. Specifies to track usage for recurring calendar period. For example, assume that CalendarPeriod.QUARTER is set. The budget tracks usage from April 1 to June 30, when the current calendar month is April, May, June. After that, it tracks usage from July 1 to September 30 when the current calendar month is July, August, September, so on. When `spend_cap` is set, must be `MONTH` (or `usage_period` left unset, which defaults to `MONTH`). `QUARTER` and `YEAR` are not supported for spend caps.", "enum": [ "CALENDAR_PERIOD_UNSPECIFIED", "MONTH", @@ -381,14 +386,14 @@ "type": "string" }, "creditTypes": { -"description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty.", +"description": "Optional. If Filter.credit_types_treatment is INCLUDE_SPECIFIED_CREDITS, this is a list of credit types to be subtracted from gross cost to determine the spend for threshold calculations. See [a list of acceptable credit type values](https://docs.cloud.google.com/billing/docs/how-to/export-data-bigquery-tables/detailed-usage#credits-type). If Filter.credit_types_treatment is **not** INCLUDE_SPECIFIED_CREDITS, this field must be empty. Not supported when `spend_cap` is set; must be empty.", "items": { "type": "string" }, "type": "array" }, "creditTypesTreatment": { -"description": "Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`.", +"description": "Optional. If not set, default behavior is `INCLUDE_ALL_CREDITS`. Must be set to `EXCLUDE_ALL_CREDITS` when `spend_cap` is set.", "enum": [ "CREDIT_TYPES_TREATMENT_UNSPECIFIED", "INCLUDE_ALL_CREDITS", @@ -399,13 +404,13 @@ "", "All types of credit are subtracted from the gross cost to determine the spend for threshold calculations.", "All types of credit are added to the net cost to determine the spend for threshold calculations.", -"[Credit types](https://cloud.google.com/billing/docs/how-to/export-data-bigquery-tables#credits-type) specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations." +"[Credit types](https://docs.cloud.google.com/billing/docs/how-to/export-data-bigquery-tables/detailed-usage#credits-type) specified in the credit_types field are subtracted from the gross cost to determine the spend for threshold calculations." ], "type": "string" }, "customPeriod": { "$ref": "GoogleCloudBillingBudgetsV1CustomPeriod", -"description": "Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur." +"description": "Optional. Specifies to track usage from any start date (required) to any end date (optional). This time period is static, it does not recur. Not supported when `spend_cap` is set." }, "labels": { "additionalProperties": { @@ -414,32 +419,32 @@ }, "type": "array" }, -"description": "Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `\"key\": value` pair. Example: `{ \"name\": \"wrench\" }`. _Currently, multiple entries or multiple values per entry are not allowed._", +"description": "Optional. A single label and value pair specifying that usage from only this set of labeled resources should be included in the budget. If omitted, the report includes all labeled and unlabeled usage. An object containing a single `\"key\": value` pair. Example: `{ \"name\": \"wrench\" }`. _Currently, multiple entries or multiple values per entry are not allowed._ Not supported when `spend_cap` is set; must be empty.", "type": "object" }, "projects": { -"description": "Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on.", +"description": "Optional. A set of projects of the form `projects/{project}`, specifying that usage from only this set of projects should be included in the budget. If omitted, the report includes all usage for the billing account, regardless of which project the usage occurred on. Must be set when `spend_cap` is set; must contain exactly one project.", "items": { "type": "string" }, "type": "array" }, "resourceAncestors": { -"description": "Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects.", +"description": "Optional. A set of folder and organization names of the form `folders/{folderId}` or `organizations/{organizationId}`, specifying that usage from only this set of folders and organizations should be included in the budget. If omitted, the budget includes all usage that the billing account pays for. If the folder or organization contains projects that are paid for by a different Cloud Billing account, the budget *doesn't* apply to those projects. Not supported when `spend_cap` is set; must be empty.", "items": { "type": "string" }, "type": "array" }, "services": { -"description": "Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://cloud.google.com/billing/v1/how-tos/catalog-api.", +"description": "Optional. A set of services of the form `services/{service_id}`, specifying that usage from only this set of services should be included in the budget. If omitted, the report includes usage for all the services. The service names are available through the Catalog API: https://docs.cloud.google.com/billing/v1/how-tos/catalog-api. When `spend_cap` is set, the services filter must be set and must contain exactly one service from this list of eligible services: https://docs.cloud.google.com/billing/docs/how-to/budgets-spend-caps#eligible-services.", "items": { "type": "string" }, "type": "array" }, "subaccounts": { -"description": "Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist.", +"description": "Optional. A set of subaccounts of the form `billingAccounts/{account_id}`, specifying that usage from only this set of subaccounts should be included in the budget. If a subaccount is set to the name of the parent account, usage from the parent account is included. If the field is omitted, the report includes usage from the parent account and all subaccounts, if they exist. Not supported when `spend_cap` is set; must be empty.", "items": { "type": "string" }, @@ -477,37 +482,82 @@ "id": "GoogleCloudBillingBudgetsV1NotificationsRule", "properties": { "disableDefaultIamRecipients": { -"description": "Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account.", +"description": "Optional. When set to true, disables default notifications sent when a threshold is exceeded. Default notifications are sent to those with Billing Account Administrator and Billing Account User IAM roles for the target account. Must be `false` (or unset) when `spend_cap` is set; default notifications cannot be disabled for spend caps.", "type": "boolean" }, "enableProjectLevelRecipients": { -"description": "Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project.", +"description": "Optional. When set to true, and when the budget has a single project configured, notifications will be sent to project level recipients of that project. This field will be ignored if the budget has multiple or no project configured. Currently, project level recipients are the users with `Owner` role on a cloud project. Must be set to `true` when `spend_cap` is set.", "type": "boolean" }, "monitoringNotificationChannels": { -"description": "Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://cloud.google.com/billing/docs/how-to/notify#send_notifications_to_slack), use a pubsubTopic and configure [programmatic notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications).", +"description": "Optional. Email targets to send notifications to when a threshold is exceeded. This is in addition to the `DefaultIamRecipients` who receive alert emails based on their billing account IAM role. The value is the full REST resource name of a Cloud Monitoring email notification channel with the form `projects/{project_id}/notificationChannels/{channel_id}`. A maximum of 5 email notifications are allowed. To customize budget alert email recipients with monitoring notification channels, you _must create the monitoring notification channels before you link them to a budget_. For guidance on setting up notification channels to use with budgets, see [Customize budget alert email recipients](https://docs.cloud.google.com/billing/docs/how-to/budgets-notification-recipients). For Cloud Billing budget alerts, you _must use email notification channels_. The other types of notification channels are _not_ supported, such as Slack, SMS, or PagerDuty. If you want to [send budget notifications to Slack](https://docs.cloud.google.com/billing/docs/how-to/send-notifications-to-slack), use a pubsubTopic and configure [programmatic notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). Not supported when `spend_cap` is set; must be empty.", "items": { "type": "string" }, "type": "array" }, "pubsubTopic": { -"description": "Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions_required_for_this_task).", +"description": "Optional. The name of the Pub/Sub topic where budget-related messages are published, in the form `projects/{project_id}/topics/{topic_id}`. Updates are sent to the topic at regular intervals; the timing of the updates is not dependent on the [threshold rules](#thresholdrule) you've set. Note that if you want your [Pub/Sub JSON object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) to contain data for `alertThresholdExceeded`, you need at least one [alert threshold rule](#thresholdrule). When you set threshold rules, you must also enable at least one of the email notification options, either using the default IAM recipients or Cloud Monitoring email notification channels. To use Pub/Sub topics with budgets, you must do the following: 1. Create the Pub/Sub topic before connecting it to your budget. For guidance, see [Manage programmatic budget alert notifications](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications). 2. Grant the API caller the `pubsub.topics.setIamPolicy` permission on the Pub/Sub topic. If not set, the API call fails with PERMISSION_DENIED. For additional details on Pub/Sub roles and permissions, see [Permissions required for this task](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#permissions). Not supported when `spend_cap` is set; must be empty.", "type": "string" }, "schemaVersion": { -"description": "Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only \"1.0\" is accepted. It represents the JSON schema as defined in https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format.", +"description": "Optional. Required when NotificationsRule.pubsub_topic is set. The schema version of the notification sent to NotificationsRule.pubsub_topic. Only \"1.0\" is accepted. It represents the JSON schema as defined in https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudBillingBudgetsV1SpendCap": { +"description": "SpendCap defines the spend cap configuration and state.", +"id": "GoogleCloudBillingBudgetsV1SpendCap", +"properties": { +"inputState": { +"description": "Required. The desired state specified by the user. Valid values for mutation: - `CONFIGURED`: Must be set when creating a spend cap (`CreateBudget`). Also valid when updating (`UpdateBudget`) to activate the spend cap. - `AWAITING_NEXT_PERIOD`: Valid only when updating (`UpdateBudget`) to explicitly lift an enforced cap. Supplying any other value will result in an INVALID_ARGUMENT error.", +"enum": [ +"STATE_UNSPECIFIED", +"CONFIGURED", +"ENFORCED", +"AWAITING_NEXT_PERIOD" +], +"enumDescriptions": [ +"Unspecified state.", +"Spend cap is configured and active.", +"Spend cap limit is reached and enforced.", +"Spend cap is waiting for the next period to start." +], "type": "string" +}, +"outputState": { +"description": "Output only. The actual resting state of the spend cap.", +"enum": [ +"STATE_UNSPECIFIED", +"CONFIGURED", +"ENFORCED", +"AWAITING_NEXT_PERIOD" +], +"enumDescriptions": [ +"Unspecified state.", +"Spend cap is configured and active.", +"Spend cap limit is reached and enforced.", +"Spend cap is waiting for the next period to start." +], +"readOnly": true, +"type": "string" +}, +"reconciling": { +"description": "Output only. Indicates whether the server is actively processing a state transition or async workflow.", +"readOnly": true, +"type": "boolean" } }, "type": "object" }, "GoogleCloudBillingBudgetsV1ThresholdRule": { -"description": "ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification_format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://cloud.google.com/billing/docs/how-to/budgets#budget-actions).", +"description": "ThresholdRule contains the definition of a threshold. Threshold rules define the triggering events used to generate a budget notification email. When a threshold is crossed (spend exceeds the specified percentages of the budget), budget alert emails are sent to the email recipients you specify in the [NotificationsRule](#notificationsrule). Threshold rules also affect the fields included in the [JSON data object](https://docs.cloud.google.com/billing/docs/how-to/budgets-programmatic-notifications#notification-format) sent to a Pub/Sub topic. Threshold rules are _required_ if using email notifications. Threshold rules are _optional_ if only setting a [`pubsubTopic` NotificationsRule](#NotificationsRule), unless you want your JSON data object to include data about the thresholds you set. For more information, see [set budget threshold rules and actions](https://docs.cloud.google.com/billing/docs/how-to/budgets#budget-actions).", "id": "GoogleCloudBillingBudgetsV1ThresholdRule", "properties": { "spendBasis": { -"description": "Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set.", +"description": "Optional. The type of basis used to determine if spend has passed the threshold. Behavior defaults to CURRENT_SPEND if not set. When `spend_cap` is set on the budget, must be `CURRENT_SPEND` or `BASIS_UNSPECIFIED`. `FORECASTED_SPEND` is not supported.", "enum": [ "BASIS_UNSPECIFIED", "CURRENT_SPEND", @@ -516,12 +566,12 @@ "enumDescriptions": [ "Unspecified threshold basis.", "Use current spend as the basis for comparison against the threshold.", -"Use forecasted spend for the period as the basis for comparison against the threshold. FORECASTED_SPEND can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period." +"Use forecasted spend for the period as the basis for comparison against the threshold. FORECASTED_SPEND can only be set when the budget's time period is a Filter.calendar_period. It cannot be set in combination with Filter.custom_period. Not supported when `spend_cap` is set." ], "type": "string" }, "thresholdPercent": { -"description": "Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number.", +"description": "Required. Send an alert when this threshold is exceeded. This is a 1.0-based percentage, so 0.5 = 50%. Validation: non-negative number. When `spend_cap` is set on the budget, `threshold_rules` must contain exactly three rules with `threshold_percent` values of `0.5`, `0.8`, and `1.0` (50%, 80%, and 100%).", "format": "double", "type": "number" } From a76ce1444dfe965e1ff30c78b2ab361a7bca3fb2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:36 +0000 Subject: [PATCH 11/41] fix(calendar): update the api #### calendar:v3 The following keys were changed: - resources.channels.methods.stop.scopes (Total Keys: 1) - resources.settings.methods.get.scopes (Total Keys: 1) - resources.settings.methods.list.scopes (Total Keys: 1) - resources.settings.methods.watch.scopes (Total Keys: 1) --- .../discovery_cache/documents/calendar.v3.json | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/calendar.v3.json b/googleapiclient/discovery_cache/documents/calendar.v3.json index d0fee5888e..e81e005421 100644 --- a/googleapiclient/discovery_cache/documents/calendar.v3.json +++ b/googleapiclient/discovery_cache/documents/calendar.v3.json @@ -50,6 +50,9 @@ "https://www.googleapis.com/auth/calendar.readonly": { "description": "See and download any calendar you can access using your Google Calendar" }, +"https://www.googleapis.com/auth/calendar.settings": { +"description": "View and edit your Calendar settings" +}, "https://www.googleapis.com/auth/calendar.settings.readonly": { "description": "View your Calendar settings" } @@ -884,6 +887,7 @@ "https://www.googleapis.com/auth/calendar.events.public.readonly", "https://www.googleapis.com/auth/calendar.events.readonly", "https://www.googleapis.com/auth/calendar.readonly", +"https://www.googleapis.com/auth/calendar.settings", "https://www.googleapis.com/auth/calendar.settings.readonly" ] } @@ -1893,6 +1897,7 @@ "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.readonly", +"https://www.googleapis.com/auth/calendar.settings", "https://www.googleapis.com/auth/calendar.settings.readonly" ] }, @@ -1926,6 +1931,7 @@ "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.readonly", +"https://www.googleapis.com/auth/calendar.settings", "https://www.googleapis.com/auth/calendar.settings.readonly" ], "supportsSubscription": true @@ -1964,6 +1970,7 @@ "scopes": [ "https://www.googleapis.com/auth/calendar", "https://www.googleapis.com/auth/calendar.readonly", +"https://www.googleapis.com/auth/calendar.settings", "https://www.googleapis.com/auth/calendar.settings.readonly" ], "supportsSubscription": true @@ -1971,7 +1978,7 @@ } } }, -"revision": "20260708", +"revision": "20260925", "rootUrl": "https://www.googleapis.com/", "schemas": { "Acl": { From 659f9d753dcb8d6418eb77a0a9de837bec5dd994 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:36 +0000 Subject: [PATCH 12/41] feat(cloudscheduler): update the api #### cloudscheduler:v1 The following keys were added: - endpoints (Total Keys: 1) #### cloudscheduler:v1beta1 The following keys were added: - endpoints (Total Keys: 1) --- .../documents/cloudscheduler.v1.json | 24 ++++++++++++++++++- .../documents/cloudscheduler.v1beta1.json | 24 ++++++++++++++++++- 2 files changed, 46 insertions(+), 2 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json index d9da83ec36..66069c343f 100644 --- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1.json @@ -15,6 +15,28 @@ "description": "Creates and manages jobs run on a regular recurring schedule.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/scheduler/", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudscheduler.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudscheduler.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudscheduler.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudscheduler.us-west3.rep.googleapis.com/", +"location": "us-west3" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -611,7 +633,7 @@ } } }, -"revision": "20260522", +"revision": "20260922", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { diff --git a/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json b/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json index 5dabe6d8c3..eb0c24ec44 100644 --- a/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/cloudscheduler.v1beta1.json @@ -15,6 +15,28 @@ "description": "Creates and manages jobs run on a regular recurring schedule.", "discoveryVersion": "v1", "documentationLink": "https://cloud.google.com/scheduler/", +"endpoints": [ +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudscheduler.us-east7.rep.googleapis.com/", +"location": "us-east7" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudscheduler.us-west1.rep.googleapis.com/", +"location": "us-west1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudscheduler.us-west2.rep.googleapis.com/", +"location": "us-west2" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://cloudscheduler.us-west3.rep.googleapis.com/", +"location": "us-west3" +} +], "fullyEncodeReservedExpansion": true, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", @@ -567,7 +589,7 @@ } } }, -"revision": "20260522", +"revision": "20260922", "rootUrl": "https://cloudscheduler.googleapis.com/", "schemas": { "AppEngineHttpTarget": { From 2cf7adbdc169708434712fa92262fe7718a24e13 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:36 +0000 Subject: [PATCH 13/41] feat(contactcenterinsights): update the api #### contactcenterinsights:v1 The following keys were added: - schemas.GoogleCloudContactcenterinsightsV1Analysis.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1Analysis.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1AnalysisRule.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1AnalysisRule.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1AssessmentRule.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1AssessmentRule.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1AuthorizedView.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1AuthorizedView.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1AuthorizedViewSet.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1AuthorizedViewSet.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsMetadata.properties.relabel.deprecated (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1BulkAnalyzeConversationsRequest.properties.relabel.deprecated (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1Conversation.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1Conversation.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1Dataset.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1Dataset.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1EncryptionSpec.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1EncryptionSpec.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1FeedbackLabel.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1FeedbackLabel.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QaQuestion.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QaQuestion.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QaQuestionTag.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QaQuestionTag.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QaScorecard.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1QaScorecard.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1Settings.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1Settings.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1Analysis.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1Analysis.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsMetadata.properties.relabel.deprecated (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1BulkAnalyzeConversationsRequest.properties.relabel.deprecated (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1alpha1Conversation.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1Conversation.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1Dataset.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1Dataset.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1EncryptionSpec.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1FeedbackLabel.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1alpha1QaQuestionTag.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainAnalysis.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainAnalysis.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsMetadata.properties.relabel.deprecated (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1mainBulkAnalyzeConversationsRequest.properties.relabel.deprecated (Total Keys: 1) - schemas.GoogleCloudContactcenterinsightsV1mainConversation.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainConversation.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainDataset.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainDataset.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainEncryptionSpec.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainEncryptionSpec.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainFeedbackLabel.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainFeedbackLabel.properties.satisfiesPzs (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQaQuestionTag.properties.satisfiesPzi (Total Keys: 2) - schemas.GoogleCloudContactcenterinsightsV1mainQaQuestionTag.properties.satisfiesPzs (Total Keys: 2) --- ...s_v1.projects.locations.analysisRules.html | 12 + ...v1.projects.locations.assessmentRules.html | 12 + ...zedViews.conversations.feedbackLabels.html | 12 + ...iewSets.authorizedViews.conversations.html | 12 + ...ns.authorizedViewSets.authorizedViews.html | 14 + ...projects.locations.authorizedViewSets.html | 12 + ....projects.locations.autoLabelingRules.html | 6 + ...ects.locations.conversations.analyses.html | 6 + ...ocations.conversations.feedbackLabels.html | 12 + ...s_v1.projects.locations.conversations.html | 46 ++- ...ects.locations.conversations.segments.html | 2 +- ...datasets.conversations.feedbackLabels.html | 12 + ...ects.locations.datasets.conversations.html | 14 + ...sights_v1.projects.locations.datasets.html | 14 + ..._v1.projects.locations.encryptionSpec.html | 2 + ...tcenterinsights_v1.projects.locations.html | 16 + ..._v1.projects.locations.qaQuestionTags.html | 10 + ...ts_v1.projects.locations.qaScorecards.html | 12 + ...ects.locations.qaScorecards.revisions.html | 24 ++ ...ns.qaScorecards.revisions.qaQuestions.html | 12 + .../documents/contactcenterinsights.v1.json | 280 +++++++++++++++++- 21 files changed, 533 insertions(+), 9 deletions(-) diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.analysisRules.html b/docs/dyn/contactcenterinsights_v1.projects.locations.analysisRules.html index 8e5dc996af..b2be484915 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.analysisRules.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.analysisRules.html @@ -147,6 +147,8 @@

Method Details

"createTime": "A String", # Output only. The time at which this analysis rule was created. "displayName": "A String", # Display Name of the analysis rule. "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated. } @@ -195,6 +197,8 @@

Method Details

"createTime": "A String", # Output only. The time at which this analysis rule was created. "displayName": "A String", # Display Name of the analysis rule. "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated. }
@@ -268,6 +272,8 @@

Method Details

"createTime": "A String", # Output only. The time at which this analysis rule was created. "displayName": "A String", # Display Name of the analysis rule. "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated. } @@ -327,6 +333,8 @@

Method Details

"createTime": "A String", # Output only. The time at which this analysis rule was created. "displayName": "A String", # Display Name of the analysis rule. "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated. }, ], @@ -394,6 +402,8 @@

Method Details

"createTime": "A String", # Output only. The time at which this analysis rule was created. "displayName": "A String", # Display Name of the analysis rule. "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated. } @@ -443,6 +453,8 @@

Method Details

"createTime": "A String", # Output only. The time at which this analysis rule was created. "displayName": "A String", # Display Name of the analysis rule. "name": "A String", # Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which this analysis rule was updated. } diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.assessmentRules.html b/docs/dyn/contactcenterinsights_v1.projects.locations.assessmentRules.html index 39978f723b..3fd122c162 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.assessmentRules.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.assessmentRules.html @@ -121,6 +121,8 @@

Method Details

"samplePercentage": 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100]. "sampleRow": "A String", # Number of the conversations that we should sample based on the dimension. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "scheduleInfo": { # Message for schedule info. # Schedule info for the assessment rule. "endTime": "A String", # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted. "schedule": "A String", # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ... @@ -150,6 +152,8 @@

Method Details

"samplePercentage": 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100]. "sampleRow": "A String", # Number of the conversations that we should sample based on the dimension. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "scheduleInfo": { # Message for schedule info. # Schedule info for the assessment rule. "endTime": "A String", # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted. "schedule": "A String", # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ... @@ -203,6 +207,8 @@

Method Details

"samplePercentage": 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100]. "sampleRow": "A String", # Number of the conversations that we should sample based on the dimension. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "scheduleInfo": { # Message for schedule info. # Schedule info for the assessment rule. "endTime": "A String", # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted. "schedule": "A String", # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ... @@ -242,6 +248,8 @@

Method Details

"samplePercentage": 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100]. "sampleRow": "A String", # Number of the conversations that we should sample based on the dimension. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "scheduleInfo": { # Message for schedule info. # Schedule info for the assessment rule. "endTime": "A String", # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted. "schedule": "A String", # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ... @@ -289,6 +297,8 @@

Method Details

"samplePercentage": 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100]. "sampleRow": "A String", # Number of the conversations that we should sample based on the dimension. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "scheduleInfo": { # Message for schedule info. # Schedule info for the assessment rule. "endTime": "A String", # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted. "schedule": "A String", # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ... @@ -318,6 +328,8 @@

Method Details

"samplePercentage": 3.14, # Percentage of conversations that we should sample based on the dimension between [0, 100]. "sampleRow": "A String", # Number of the conversations that we should sample based on the dimension. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "scheduleInfo": { # Message for schedule info. # Schedule info for the assessment rule. "endTime": "A String", # End time of the schedule. If not specified, will keep scheduling new pipelines for execution util the schedule is no longer active or deleted. "schedule": "A String", # The groc expression. Format: `every number [synchronized]` Time units can be: minutes, hours Synchronized is optional and indicates that the schedule should be synchronized to the start of the interval: every 5 minutes synchronized means 00:00, 00:05 ... Otherwise the start time is random within the interval. Example: `every 5 minutes` could be 00:02, 00:07, 00:12, ... diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.html index 7e6755b666..9df2896b8a 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.feedbackLabels.html @@ -126,6 +126,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -154,6 +156,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -206,6 +210,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -245,6 +251,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -291,6 +299,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -319,6 +329,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html index ffaf29dba7..cca37eed88 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.conversations.html @@ -479,6 +479,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -535,6 +537,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -701,6 +705,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. @@ -1105,6 +1111,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -1161,6 +1169,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -1327,6 +1337,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html index 026ab67915..33b3c1ff01 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.authorizedViews.html @@ -149,6 +149,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the authorized view was created. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the authorized view was updated. } @@ -166,6 +168,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the authorized view was created. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the authorized view was updated. } @@ -259,6 +263,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the authorized view was created. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the authorized view was updated. } @@ -336,6 +342,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the authorized view was created. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the authorized view was updated. }, ], @@ -371,6 +379,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the authorized view was created. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the authorized view was updated. } @@ -388,6 +398,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the authorized view was created. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the authorized view was updated. } @@ -568,6 +580,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the authorized view was created. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the authorized view was updated. }, ], diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.html b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.html index e69343252e..6c5157ab14 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.authorizedViewSets.html @@ -119,6 +119,8 @@

Method Details

"createTime": "A String", # Output only. Create time. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time. } @@ -135,6 +137,8 @@

Method Details

"createTime": "A String", # Output only. Create time. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time. } @@ -176,6 +180,8 @@

Method Details

"createTime": "A String", # Output only. Create time. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time. } @@ -204,6 +210,8 @@

Method Details

"createTime": "A String", # Output only. Create time. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time. }, ], @@ -238,6 +246,8 @@

Method Details

"createTime": "A String", # Output only. Create time. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time. } @@ -254,6 +264,8 @@

Method Details

"createTime": "A String", # Output only. Create time. "displayName": "A String", # Display Name. Limit 64 characters. "name": "A String", # Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time. } diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html index 0e04031b3f..dfd48e62cd 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.autoLabelingRules.html @@ -590,6 +590,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -646,6 +648,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -812,6 +816,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html index 491ddec5a1..c0d4e64c28 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.analyses.html @@ -313,6 +313,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. } x__xgafv: string, V1 error format. @@ -582,6 +584,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. } @@ -810,6 +814,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, ], "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html index 2720b4b297..1cdcd1216c 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html @@ -126,6 +126,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -154,6 +156,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -206,6 +210,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -245,6 +251,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -291,6 +299,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -319,6 +329,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html index adc0a0e511..3cfc956224 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.html @@ -180,7 +180,7 @@

Method Details

}, "filter": "A String", # Required. Filter used to select the subset of conversations to analyze. "parent": "A String", # Required. The parent resource to create analyses in. - "relabel": True or False, # Optional. If true, the labeling rules will be re-evaluated for the conversations. + "relabel": True or False, # Optional. Deprecated: Use `annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations. } x__xgafv: string, V1 error format. @@ -569,6 +569,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -625,6 +627,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -791,6 +795,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. @@ -1177,6 +1183,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -1233,6 +1241,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -1399,6 +1409,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. @@ -1847,6 +1859,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -1903,6 +1917,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -2069,6 +2085,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. @@ -2542,6 +2560,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -2598,6 +2618,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -2764,6 +2786,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. @@ -3168,6 +3192,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -3224,6 +3250,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -3390,6 +3418,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. @@ -3778,6 +3808,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -3834,6 +3866,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -4000,6 +4034,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. @@ -4142,6 +4178,8 @@

Method Details

"description": "A String", # Dataset description. "displayName": "A String", # Display name for the dataaset "name": "A String", # Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "ttl": "A String", # Optional. Option TTL for the dataset. "type": "A String", # Dataset usage type. "updateTime": "A String", # Output only. Dataset update time. @@ -4445,6 +4483,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -4501,6 +4541,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -4667,6 +4709,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html index 2623ae6aed..1144f34fc4 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.conversations.segments.html @@ -124,7 +124,7 @@

Method Details

}, "filter": "A String", # Required. Filter used to select the subset of conversations to analyze. "parent": "A String", # Required. The parent resource to create analyses in. - "relabel": True or False, # Optional. If true, the labeling rules will be re-evaluated for the conversations. + "relabel": True or False, # Optional. Deprecated: Use `annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations. } x__xgafv: string, V1 error format. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.feedbackLabels.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.feedbackLabels.html index 378eff83b8..de97f3ee01 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.feedbackLabels.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.feedbackLabels.html @@ -126,6 +126,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -154,6 +156,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -206,6 +210,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -245,6 +251,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -291,6 +299,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } @@ -319,6 +329,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. } diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html index 5cf96c16ad..b8550b16f0 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.conversations.html @@ -534,6 +534,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -590,6 +592,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -756,6 +760,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. @@ -1229,6 +1235,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -1285,6 +1293,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -1451,6 +1461,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. @@ -1610,6 +1622,8 @@

Method Details

"description": "A String", # Dataset description. "displayName": "A String", # Display name for the dataaset "name": "A String", # Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "ttl": "A String", # Optional. Option TTL for the dataset. "type": "A String", # Dataset usage type. "updateTime": "A String", # Output only. Dataset update time. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.html b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.html index 0572b19596..a22cbe0929 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.datasets.html @@ -292,6 +292,8 @@

Method Details

"description": "A String", # Dataset description. "displayName": "A String", # Display name for the dataaset "name": "A String", # Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "ttl": "A String", # Optional. Option TTL for the dataset. "type": "A String", # Dataset usage type. "updateTime": "A String", # Output only. Dataset update time. @@ -311,6 +313,8 @@

Method Details

"description": "A String", # Dataset description. "displayName": "A String", # Display name for the dataaset "name": "A String", # Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "ttl": "A String", # Optional. Option TTL for the dataset. "type": "A String", # Dataset usage type. "updateTime": "A String", # Output only. Dataset update time. @@ -371,6 +375,8 @@

Method Details

"description": "A String", # Dataset description. "displayName": "A String", # Display name for the dataaset "name": "A String", # Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "ttl": "A String", # Optional. Option TTL for the dataset. "type": "A String", # Dataset usage type. "updateTime": "A String", # Output only. Dataset update time. @@ -401,6 +407,8 @@

Method Details

"description": "A String", # Dataset description. "displayName": "A String", # Display name for the dataaset "name": "A String", # Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "ttl": "A String", # Optional. Option TTL for the dataset. "type": "A String", # Dataset usage type. "updateTime": "A String", # Output only. Dataset update time. @@ -445,6 +453,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -494,6 +504,8 @@

Method Details

"description": "A String", # Dataset description. "displayName": "A String", # Display name for the dataaset "name": "A String", # Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "ttl": "A String", # Optional. Option TTL for the dataset. "type": "A String", # Dataset usage type. "updateTime": "A String", # Output only. Dataset update time. @@ -513,6 +525,8 @@

Method Details

"description": "A String", # Dataset description. "displayName": "A String", # Display name for the dataaset "name": "A String", # Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "ttl": "A String", # Optional. Option TTL for the dataset. "type": "A String", # Dataset usage type. "updateTime": "A String", # Output only. Dataset update time. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.encryptionSpec.html b/docs/dyn/contactcenterinsights_v1.projects.locations.encryptionSpec.html index 6901ede0dd..b6ba7e30f5 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.encryptionSpec.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.encryptionSpec.html @@ -99,6 +99,8 @@

Method Details

"encryptionSpec": { # A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`). # Required. The encryption spec used for CMEK encryption. It is required that the kms key is in the same region as the endpoint. The same key will be used for all provisioned resources, if encryption is available. If the `kms_key_name` field is left empty, no encryption will be enforced. "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, } diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.html b/docs/dyn/contactcenterinsights_v1.projects.locations.html index 6cdb04dfb3..a5170fdd89 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.html @@ -457,6 +457,8 @@

Method Details

{ # A customer-managed encryption key specification that can be applied to all created resources (e.g. `Conversation`). "kmsKey": "A String", # Required. The name of customer-managed encryption key that is used to secure a resource and its sub-resources. If empty, the resource is secured by our default encryption key. Only the key in the same location as this resource is allowed to be used for encryption. Format: `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{key}` "name": "A String", # Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. } @@ -528,6 +530,8 @@

Method Details

"deidentifyTemplate": "A String", # The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}` "inspectTemplate": "A String", # The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}` }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "screenRecordingBucketUri": "A String", # Optional. The path to a Cloud Storage bucket containing conversation screen recordings. If provided, Insights will search in the bucket for a screen recording file matching the conversation data source object name prefix. If matches are found, these file URIs will be stored in the conversation screen recordings field. "speechConfig": { # Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint. # Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform. "disableWordTimeOffsets": True or False, # Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false. @@ -573,6 +577,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -1008,6 +1014,8 @@

Method Details

"createTime": "A String", # Output only. The time at which the analysis was created, which occurs when the long-running operation completes. "name": "A String", # Immutable. The resource name of the analysis. Format: projects/{project}/locations/{location}/conversations/{conversation}/analyses/{analysis} "requestTime": "A String", # Output only. The time at which the analysis was requested. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. }, "latestSummary": { # Conversation summarization suggestion data. # Output only. Latest summary of the conversation. "answerRecord": "A String", # The name of the answer record. Format: projects/{project}/locations/{location}/answerRecords/{answer_record} @@ -1064,6 +1072,8 @@

Method Details

"skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. "strValue": "A String", # String value. }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. Update time of the label. }, ], @@ -1230,6 +1240,8 @@

Method Details

}, }, ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "startTime": "A String", # The time at which the conversation started. "transcript": { # A message representing the transcript of a conversation. # Output only. The conversation transcript. "transcriptSegments": [ # A list of sequential transcript segments that comprise the conversation. @@ -1519,6 +1531,8 @@

Method Details

"deidentifyTemplate": "A String", # The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}` "inspectTemplate": "A String", # The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}` }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "screenRecordingBucketUri": "A String", # Optional. The path to a Cloud Storage bucket containing conversation screen recordings. If provided, Insights will search in the bucket for a screen recording file matching the conversation data source object name prefix. If matches are found, these file URIs will be stored in the conversation screen recordings field. "speechConfig": { # Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint. # Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform. "disableWordTimeOffsets": True or False, # Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false. @@ -1591,6 +1605,8 @@

Method Details

"deidentifyTemplate": "A String", # The fully-qualified DLP deidentify template resource name. Format: `projects/{project}/deidentifyTemplates/{template}` "inspectTemplate": "A String", # The fully-qualified DLP inspect template resource name. Format: `projects/{project}/locations/{location}/inspectTemplates/{template}` }, + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "screenRecordingBucketUri": "A String", # Optional. The path to a Cloud Storage bucket containing conversation screen recordings. If provided, Insights will search in the bucket for a screen recording file matching the conversation data source object name prefix. If matches are found, these file URIs will be stored in the conversation screen recordings field. "speechConfig": { # Speech-to-Text configuration. Speech-to-Text settings are applied to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversation coming from CCAI Platform. They are not applied to conversations ingested from the `CreateConversation` endpoint. # Optional. Default Speech-to-Text resources to use while ingesting audio files. Optional, CCAI Insights will create a default if not provided. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform. "disableWordTimeOffsets": True or False, # Whether to disable word time offsets. If true, the `enable_word_time_offsets` field in the recognition config will be set to false. diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.qaQuestionTags.html b/docs/dyn/contactcenterinsights_v1.projects.locations.qaQuestionTags.html index fa202ad701..62b090c3c9 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.qaQuestionTags.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.qaQuestionTags.html @@ -114,6 +114,8 @@

Method Details

"qaQuestionIds": [ # Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional. "A String", ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the question tag was updated. } @@ -133,6 +135,8 @@

Method Details

"qaQuestionIds": [ # Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional. "A String", ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the question tag was updated. } @@ -193,6 +197,8 @@

Method Details

"qaQuestionIds": [ # Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional. "A String", ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the question tag was updated. } @@ -222,6 +228,8 @@

Method Details

"qaQuestionIds": [ # Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional. "A String", ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the question tag was updated. }, ], @@ -244,6 +252,8 @@

Method Details

"qaQuestionIds": [ # Optional. The list of Scorecard Question IDs that the tag applies to. Each QaQuestionId is represented as a full resource name containing the Question ID. Lastly, Since a tag may not necessarily be referenced by any Scorecard Questions, we treat this field as optional. "A String", ], + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "updateTime": "A String", # Output only. The most recent time at which the question tag was updated. } diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.html b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.html index a0b7db2436..bab741193d 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.html @@ -121,6 +121,8 @@

Method Details

"displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. } @@ -140,6 +142,8 @@

Method Details

"displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. } @@ -184,6 +188,8 @@

Method Details

"displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. } @@ -220,6 +226,8 @@

Method Details

"displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. }, @@ -256,6 +264,8 @@

Method Details

"displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. } @@ -275,6 +285,8 @@

Method Details

"displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. } diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.html b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.html index a01c1d2bc9..5c02848bd2 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.html @@ -127,12 +127,16 @@

Method Details

], "createTime": "A String", # Output only. The timestamp that the revision was created. "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation. "createTime": "A String", # Output only. The time at which this scorecard was created. "description": "A String", # A text description explaining the intent of the scorecard. "displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. }, @@ -154,12 +158,16 @@

Method Details

], "createTime": "A String", # Output only. The timestamp that the revision was created. "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation. "createTime": "A String", # Output only. The time at which this scorecard was created. "description": "A String", # A text description explaining the intent of the scorecard. "displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. }, @@ -212,12 +220,16 @@

Method Details

], "createTime": "A String", # Output only. The timestamp that the revision was created. "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation. "createTime": "A String", # Output only. The time at which this scorecard was created. "description": "A String", # A text description explaining the intent of the scorecard. "displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. }, @@ -245,12 +257,16 @@

Method Details

], "createTime": "A String", # Output only. The timestamp that the revision was created. "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation. "createTime": "A String", # Output only. The time at which this scorecard was created. "description": "A String", # A text description explaining the intent of the scorecard. "displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. }, @@ -290,12 +306,16 @@

Method Details

], "createTime": "A String", # Output only. The timestamp that the revision was created. "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation. "createTime": "A String", # Output only. The time at which this scorecard was created. "description": "A String", # A text description explaining the intent of the scorecard. "displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. }, @@ -388,12 +408,16 @@

Method Details

], "createTime": "A String", # Output only. The timestamp that the revision was created. "name": "A String", # Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "snapshot": { # A QaScorecard represents a collection of questions to be scored during analysis. # The snapshot of the scorecard at the time of this revision's creation. "createTime": "A String", # Output only. The time at which this scorecard was created. "description": "A String", # A text description explaining the intent of the scorecard. "displayName": "A String", # The user-specified display name of the scorecard. "isDefault": True or False, # Whether the scorecard is the default one for the project. A default scorecard cannot be deleted and will always appear first in scorecard selector. "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "source": "A String", # Output only. The source of the scorecard. "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated. }, diff --git a/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.qaQuestions.html b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.qaQuestions.html index b1d01e36a3..86c70b80f0 100644 --- a/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.qaQuestions.html +++ b/docs/dyn/contactcenterinsights_v1.projects.locations.qaScorecards.revisions.qaQuestions.html @@ -139,6 +139,8 @@

Method Details

}, "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" "questionType": "A String", # The type of question. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "tags": [ # Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., "BUSINESS", "COMPLIANCE", and "CUSTOMER"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question. "A String", ], @@ -190,6 +192,8 @@

Method Details

}, "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" "questionType": "A String", # The type of question. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "tags": [ # Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., "BUSINESS", "COMPLIANCE", and "CUSTOMER"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question. "A String", ], @@ -265,6 +269,8 @@

Method Details

}, "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" "questionType": "A String", # The type of question. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "tags": [ # Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., "BUSINESS", "COMPLIANCE", and "CUSTOMER"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question. "A String", ], @@ -327,6 +333,8 @@

Method Details

}, "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" "questionType": "A String", # The type of question. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "tags": [ # Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., "BUSINESS", "COMPLIANCE", and "CUSTOMER"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question. "A String", ], @@ -395,6 +403,8 @@

Method Details

}, "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" "questionType": "A String", # The type of question. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "tags": [ # Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., "BUSINESS", "COMPLIANCE", and "CUSTOMER"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question. "A String", ], @@ -446,6 +456,8 @@

Method Details

}, "questionBody": "A String", # Question text. E.g., "Did the agent greet the customer?" "questionType": "A String", # The type of question. + "satisfiesPzi": True or False, # Output only. Whether this resource is zone isolated. + "satisfiesPzs": True or False, # Output only. Whether this resource is zone separated. "tags": [ # Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., "BUSINESS", "COMPLIANCE", and "CUSTOMER"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question. "A String", ], diff --git a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json index 63c933e201..2f69ed7364 100644 --- a/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json +++ b/googleapiclient/discovery_cache/documents/contactcenterinsights.v1.json @@ -6248,7 +6248,7 @@ } } }, -"revision": "20260902", +"revision": "20260930", "rootUrl": "https://contactcenterinsights.googleapis.com/", "schemas": { "GoogleCloudCesV1mainAgentTransfer": { @@ -6574,6 +6574,16 @@ "format": "google-datetime", "readOnly": true, "type": "string" +}, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" } }, "type": "object" @@ -6686,6 +6696,16 @@ "description": "Identifier. The resource name of the analysis rule. Format: projects/{project}/locations/{location}/analysisRules/{analysis_rule}", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. The most recent time at which this analysis rule was updated.", "format": "google-datetime", @@ -6984,6 +7004,16 @@ true "$ref": "GoogleCloudContactcenterinsightsV1SampleRule", "description": "The sample rule for the assessment rule." }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "scheduleInfo": { "$ref": "GoogleCloudContactcenterinsightsV1ScheduleInfo", "description": "Schedule info for the assessment rule." @@ -7117,6 +7147,16 @@ true "description": "Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. The most recent time at which the authorized view was updated.", "format": "google-datetime", @@ -7144,6 +7184,16 @@ true "description": "Identifier. The resource name of the AuthorizedViewSet. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. Update time.", "format": "google-datetime", @@ -7259,7 +7309,8 @@ true "type": "array" }, "relabel": { -"description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", +"deprecated": true, +"description": "Output only. Deprecated: Use `request.annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations.", "readOnly": true, "type": "boolean" }, @@ -7297,7 +7348,8 @@ true "type": "string" }, "relabel": { -"description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", +"deprecated": true, +"description": "Optional. Deprecated: Use `annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" } }, @@ -8172,6 +8224,16 @@ true "readOnly": true, "type": "array" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "startTime": { "description": "The time at which the conversation started.", "format": "google-datetime", @@ -9232,6 +9294,16 @@ true "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "ttl": { "description": "Optional. Option TTL for the dataset.", "format": "google-duration", @@ -9775,6 +9847,16 @@ true "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" +}, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" } }, "type": "object" @@ -10142,6 +10224,16 @@ true "$ref": "GoogleCloudContactcenterinsightsV1QaAnswerAnswerValue", "description": "QaAnswer label used for Quality AI example conversations." }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. Update time of the label.", "format": "google-datetime", @@ -12085,6 +12177,16 @@ true ], "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "tags": { "description": "Questions are tagged for categorization and scoring. Tags can either be: - Default Tags: These are predefined categories. They are identified by their string value (e.g., \"BUSINESS\", \"COMPLIANCE\", and \"CUSTOMER\"). - Custom Tags: These are user-defined categories. They are identified by their full resource name (e.g., projects/{project}/locations/{location}/qaQuestionTags/{qa_question_tag}). Both default and custom tags are used to group questions and to influence the scoring of each question.", "items": { @@ -12210,6 +12312,16 @@ true }, "type": "array" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. The most recent time at which the question tag was updated.", "format": "google-datetime", @@ -12282,6 +12394,16 @@ true "description": "Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "source": { "description": "Output only. The source of the scorecard.", "enum": [ @@ -12464,6 +12586,16 @@ true "description": "Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}/revisions/{revision}", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "snapshot": { "$ref": "GoogleCloudContactcenterinsightsV1QaScorecard", "description": "The snapshot of the scorecard at the time of this revision's creation." @@ -13403,6 +13535,16 @@ true "$ref": "GoogleCloudContactcenterinsightsV1RedactionConfig", "description": "Default DLP redaction resources to be applied while ingesting conversations. This applies to conversations ingested from the `UploadConversation` and `IngestConversations` endpoints, including conversations coming from CCAI Platform." }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "screenRecordingBucketUri": { "description": "Optional. The path to a Cloud Storage bucket containing conversation screen recordings. If provided, Insights will search in the bucket for a screen recording file matching the conversation data source object name prefix. If matches are found, these file URIs will be stored in the conversation screen recordings field.", "type": "string" @@ -14029,6 +14171,16 @@ true "format": "google-datetime", "readOnly": true, "type": "string" +}, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" } }, "type": "object" @@ -14350,7 +14502,8 @@ true "type": "array" }, "relabel": { -"description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", +"deprecated": true, +"description": "Output only. Deprecated: Use `request.annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations.", "readOnly": true, "type": "boolean" }, @@ -14388,7 +14541,8 @@ true "type": "string" }, "relabel": { -"description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", +"deprecated": true, +"description": "Optional. Deprecated: Use `annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" } }, @@ -14736,6 +14890,16 @@ true "readOnly": true, "type": "array" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "startTime": { "description": "The time at which the conversation started.", "format": "google-datetime", @@ -15673,6 +15837,16 @@ true "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "ttl": { "description": "Optional. Option TTL for the dataset.", "format": "google-duration", @@ -16163,6 +16337,16 @@ true "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" +}, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" } }, "type": "object" @@ -16519,6 +16703,16 @@ true "$ref": "GoogleCloudContactcenterinsightsV1alpha1QaAnswerAnswerValue", "description": "QaAnswer label used for Quality AI example conversations." }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. Update time of the label.", "format": "google-datetime", @@ -17572,6 +17766,16 @@ true }, "type": "array" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. The most recent time at which the question tag was updated.", "format": "google-datetime", @@ -18760,6 +18964,16 @@ true "format": "google-datetime", "readOnly": true, "type": "string" +}, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" } }, "type": "object" @@ -19081,7 +19295,8 @@ true "type": "array" }, "relabel": { -"description": "Output only. If true, the labeling rules will be re-evaluated for the conversations.", +"deprecated": true, +"description": "Output only. Deprecated: Use `request.annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations.", "readOnly": true, "type": "boolean" }, @@ -19119,7 +19334,8 @@ true "type": "string" }, "relabel": { -"description": "Optional. If true, the labeling rules will be re-evaluated for the conversations.", +"deprecated": true, +"description": "Optional. Deprecated: Use `annotator_selector.run_auto_labeling_annotator` instead. If true, the labeling rules will be re-evaluated for the conversations.", "type": "boolean" } }, @@ -19647,6 +19863,16 @@ true "readOnly": true, "type": "array" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "startTime": { "description": "The time at which the conversation started.", "format": "google-datetime", @@ -20584,6 +20810,16 @@ true "description": "Immutable. Identifier. Resource name of the dataset. Format: projects/{project}/locations/{location}/datasets/{dataset}", "type": "string" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "ttl": { "description": "Optional. Option TTL for the dataset.", "format": "google-duration", @@ -21074,6 +21310,16 @@ true "name": { "description": "Immutable. The resource name of the encryption key specification resource. Format: projects/{project}/locations/{location}/encryptionSpec", "type": "string" +}, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" } }, "type": "object" @@ -21430,6 +21676,16 @@ true "$ref": "GoogleCloudContactcenterinsightsV1mainQaAnswerAnswerValue", "description": "QaAnswer label used for Quality AI example conversations." }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. Update time of the label.", "format": "google-datetime", @@ -22483,6 +22739,16 @@ true }, "type": "array" }, +"satisfiesPzi": { +"description": "Output only. Whether this resource is zone isolated.", +"readOnly": true, +"type": "boolean" +}, +"satisfiesPzs": { +"description": "Output only. Whether this resource is zone separated.", +"readOnly": true, +"type": "boolean" +}, "updateTime": { "description": "Output only. The most recent time at which the question tag was updated.", "format": "google-datetime", From 708ef37273ad13c5b60431e47d5ed145e3e0192f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:36 +0000 Subject: [PATCH 14/41] feat(containeranalysis): update the api #### containeranalysis:v1 The following keys were added: - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage (Total Keys: 17) - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.resourceUsage (Total Keys: 2) #### containeranalysis:v1alpha1 The following keys were added: - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage (Total Keys: 17) - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.resourceUsage (Total Keys: 2) #### containeranalysis:v1beta1 The following keys were added: - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage (Total Keys: 17) - schemas.ContaineranalysisGoogleDevtoolsCloudbuildV1Results.properties.resourceUsage (Total Keys: 2) --- .../documents/containeranalysis.v1.json | 44 ++++++++++++++++++- .../documents/containeranalysis.v1alpha1.json | 44 ++++++++++++++++++- .../documents/containeranalysis.v1beta1.json | 44 ++++++++++++++++++- 3 files changed, 129 insertions(+), 3 deletions(-) diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json index 8366cf4583..ac93742f7b 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1.json @@ -1715,7 +1715,7 @@ } } }, -"revision": "20260918", +"revision": "20260929", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -3770,6 +3770,43 @@ false }, "type": "object" }, +"ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage": { +"description": "Aggregated/summary metrics over the entire build lifecycle.", +"id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage", +"properties": { +"averageCpuUtilization": { +"description": "Output only. The average CPU utilization ratio across all vCPUs over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"averageMemoryUtilization": { +"description": "Output only. The average memory utilization ratio over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"peakCpuUtilization": { +"description": "Output only. The highest CPU utilization ratio across all vCPUs observed over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"peakMemoryUtilization": { +"description": "Output only. The highest memory utilization ratio observed over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"totalCpuDuration": { +"description": "Output only. Total CPU execution time consumed across all cores during build execution.", +"format": "google-duration", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep": { "description": "A step in the build pipeline.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep", @@ -4334,6 +4371,11 @@ false "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage" }, "type": "array" +}, +"resourceUsage": { +"$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage", +"description": "Output only. Aggregated metrics for the build.", +"readOnly": true } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json index fc6531cb57..7573b962ea 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1alpha1.json @@ -1454,7 +1454,7 @@ } } }, -"revision": "20260918", +"revision": "20260929", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -3308,6 +3308,43 @@ false }, "type": "object" }, +"ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage": { +"description": "Aggregated/summary metrics over the entire build lifecycle.", +"id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage", +"properties": { +"averageCpuUtilization": { +"description": "Output only. The average CPU utilization ratio across all vCPUs over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"averageMemoryUtilization": { +"description": "Output only. The average memory utilization ratio over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"peakCpuUtilization": { +"description": "Output only. The highest CPU utilization ratio across all vCPUs observed over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"peakMemoryUtilization": { +"description": "Output only. The highest memory utilization ratio observed over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"totalCpuDuration": { +"description": "Output only. Total CPU execution time consumed across all cores during build execution.", +"format": "google-duration", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep": { "description": "A step in the build pipeline.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep", @@ -3872,6 +3909,11 @@ false "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage" }, "type": "array" +}, +"resourceUsage": { +"$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage", +"description": "Output only. Aggregated metrics for the build.", +"readOnly": true } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json index 390f731ede..fefd951ccc 100644 --- a/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/containeranalysis.v1beta1.json @@ -1771,7 +1771,7 @@ } } }, -"revision": "20260918", +"revision": "20260929", "rootUrl": "https://containeranalysis.googleapis.com/", "schemas": { "AISkillAnalysisNote": { @@ -3684,6 +3684,43 @@ false }, "type": "object" }, +"ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage": { +"description": "Aggregated/summary metrics over the entire build lifecycle.", +"id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage", +"properties": { +"averageCpuUtilization": { +"description": "Output only. The average CPU utilization ratio across all vCPUs over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"averageMemoryUtilization": { +"description": "Output only. The average memory utilization ratio over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"peakCpuUtilization": { +"description": "Output only. The highest CPU utilization ratio across all vCPUs observed over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"peakMemoryUtilization": { +"description": "Output only. The highest memory utilization ratio observed over the duration of the build, expressed as a fraction in the range [0.0, 1.0].", +"format": "float", +"readOnly": true, +"type": "number" +}, +"totalCpuDuration": { +"description": "Output only. Total CPU execution time consumed across all cores during build execution.", +"format": "google-duration", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep": { "description": "A step in the build pipeline.", "id": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildStep", @@ -4248,6 +4285,11 @@ false "$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1UploadedPythonPackage" }, "type": "array" +}, +"resourceUsage": { +"$ref": "ContaineranalysisGoogleDevtoolsCloudbuildV1BuildResourceUsage", +"description": "Output only. Aggregated metrics for the build.", +"readOnly": true } }, "type": "object" From e38b9ac9a05a23a91012a82b39175706e71f3d64 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:36 +0000 Subject: [PATCH 15/41] feat(dataplex): update the api #### dataplex:v1 The following keys were deleted: - resources.projects.resources.locations.resources.dataAttributeBindings.methods.create (Total Keys: 17) - resources.projects.resources.locations.resources.dataAttributeBindings.methods.delete (Total Keys: 12) - resources.projects.resources.locations.resources.dataAttributeBindings.methods.get (Total Keys: 12) - resources.projects.resources.locations.resources.dataAttributeBindings.methods.list (Total Keys: 21) - resources.projects.resources.locations.resources.dataAttributeBindings.methods.patch (Total Keys: 18) - resources.projects.resources.locations.resources.dataTaxonomies.methods.create (Total Keys: 17) - resources.projects.resources.locations.resources.dataTaxonomies.methods.delete (Total Keys: 12) - resources.projects.resources.locations.resources.dataTaxonomies.methods.get (Total Keys: 12) - resources.projects.resources.locations.resources.dataTaxonomies.methods.list (Total Keys: 21) - resources.projects.resources.locations.resources.dataTaxonomies.methods.patch (Total Keys: 18) - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.create (Total Keys: 17) - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.delete (Total Keys: 12) - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.get (Total Keys: 12) - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.list (Total Keys: 21) - resources.projects.resources.locations.resources.dataTaxonomies.resources.attributes.methods.patch (Total Keys: 18) - schemas.GoogleCloudDataplexV1DataAccessSpec (Total Keys: 4) - schemas.GoogleCloudDataplexV1DataAttribute (Total Keys: 48) - schemas.GoogleCloudDataplexV1DataTaxonomy (Total Keys: 22) - schemas.GoogleCloudDataplexV1ListDataAttributeBindingsResponse (Total Keys: 7) - schemas.GoogleCloudDataplexV1ListDataAttributesResponse (Total Keys: 7) - schemas.GoogleCloudDataplexV1ListDataTaxonomiesResponse (Total Keys: 7) - schemas.GoogleCloudDataplexV1ResourceAccessSpec (Total Keys: 8) The following keys were added: - resources.projects.resources.locations.resources.agentTasks.methods.getIamPolicy (Total Keys: 14) - resources.projects.resources.locations.resources.agentTasks.methods.setIamPolicy (Total Keys: 12) - resources.projects.resources.locations.resources.agentTasks.methods.testIamPermissions (Total Keys: 12) - schemas.GoogleCloudDataplexV1DataAssetAccessGroupConfig.properties.state (Total Keys: 2) - schemas.GoogleCloudDataplexV1DataProductAccessGroup.properties.defaultIamRoleConfig.$ref (Total Keys: 1) - schemas.GoogleCloudDataplexV1DataProductAccessGroupDefaultIamRoleConfig (Total Keys: 3) --- ...plex_v1.projects.locations.agentTasks.html | 258 ++++ ...jects.locations.dataAttributeBindings.html | 290 ---- ...cts.locations.dataProducts.dataAssets.html | 4 + ...ex_v1.projects.locations.dataProducts.html | 12 + ...s.locations.dataTaxonomies.attributes.html | 314 ---- ..._v1.projects.locations.dataTaxonomies.html | 250 ---- docs/dyn/dataplex_v1.projects.locations.html | 5 + .../documents/dataplex.v1.json | 1294 ++++------------- 8 files changed, 544 insertions(+), 1883 deletions(-) create mode 100644 docs/dyn/dataplex_v1.projects.locations.agentTasks.html diff --git a/docs/dyn/dataplex_v1.projects.locations.agentTasks.html b/docs/dyn/dataplex_v1.projects.locations.agentTasks.html new file mode 100644 index 0000000000..9703f62452 --- /dev/null +++ b/docs/dyn/dataplex_v1.projects.locations.agentTasks.html @@ -0,0 +1,258 @@ + + + +

Cloud Dataplex API . projects . locations . agentTasks

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

+

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

+

Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

+

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

+

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

+

Method Details

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

Instance Methods

close()

Close httplib2 connections.

-

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

-

Create a DataAttributeBinding resource.

-

- delete(name, etag=None, x__xgafv=None)

-

Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.

-

- get(name, x__xgafv=None)

-

Retrieves a DataAttributeBinding resource.

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

-

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

-

Lists DataAttributeBinding resources in a project and location.

-

- list_next(previous_request, previous_response)

-

Retrieves the next page of results.

-

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

-

Updates a DataAttributeBinding resource.

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.

@@ -110,147 +92,6 @@

Method Details

Close httplib2 connections.
-
- create(parent, body=None, dataAttributeBindingId=None, validateOnly=None, x__xgafv=None) -
Create a DataAttributeBinding resource.
-
-Args:
-  parent: string, Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # DataAttributeBinding represents binding of attributes to resources. Eg: Bind 'CustomerInfo' entity with 'PII' attribute.
-  "attributes": [ # Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
-    "A String",
-  ],
-  "createTime": "A String", # Output only. The time when the DataAttributeBinding was created.
-  "description": "A String", # Optional. Description of the DataAttributeBinding.
-  "displayName": "A String", # Optional. User friendly display name.
-  "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. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
-  "labels": { # Optional. User-defined labels for the DataAttributeBinding.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
-  "paths": [ # Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
-    { # Represents a subresource of the given resource, and associated bindings with it. Currently supported subresources are column and partition schema fields within a table.
-      "attributes": [ # Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
-        "A String",
-      ],
-      "name": "A String", # Required. The name identifier of the path. Nested columns should be of the form: 'address.city'.
-    },
-  ],
-  "resource": "A String", # Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.
-  "uid": "A String", # Output only. System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the DataAttributeBinding was last updated.
-}
-
-  dataAttributeBindingId: string, Required. DataAttributeBinding 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 Location.
-  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- delete(name, etag=None, x__xgafv=None) -
Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.
-
-Args:
-  name: string, Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id} (required)
-  etag: string, Required. If the client provided etag value does not match the current etag value, the DeleteDataAttributeBindingRequest method returns an ABORTED error response. Etags must be used when calling the DeleteDataAttributeBinding.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- get(name, x__xgafv=None) -
Retrieves a DataAttributeBinding resource.
-
-Args:
-  name: string, Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id} (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # DataAttributeBinding represents binding of attributes to resources. Eg: Bind 'CustomerInfo' entity with 'PII' attribute.
-  "attributes": [ # Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
-    "A String",
-  ],
-  "createTime": "A String", # Output only. The time when the DataAttributeBinding was created.
-  "description": "A String", # Optional. Description of the DataAttributeBinding.
-  "displayName": "A String", # Optional. User friendly display name.
-  "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. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
-  "labels": { # Optional. User-defined labels for the DataAttributeBinding.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
-  "paths": [ # Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
-    { # Represents a subresource of the given resource, and associated bindings with it. Currently supported subresources are column and partition schema fields within a table.
-      "attributes": [ # Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
-        "A String",
-      ],
-      "name": "A String", # Required. The name identifier of the path. Nested columns should be of the form: 'address.city'.
-    },
-  ],
-  "resource": "A String", # Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.
-  "uid": "A String", # Output only. System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the DataAttributeBinding was last updated.
-}
-
-
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.
@@ -299,137 +140,6 @@ 

Method Details

}
-
- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists DataAttributeBinding resources in a project and location.
-
-Args:
-  parent: string, Required. The resource name of the Location: projects/{project_number}/locations/{location_id} (required)
-  filter: string, Optional. Filter request. Filter using resource: filter=resource:"resource-name" Filter using attribute: filter=attributes:"attribute-name" Filter using attribute in paths list: filter=paths.attributes:"attribute-name"
-  orderBy: string, Optional. Order by fields for the result.
-  pageSize: integer, Optional. Maximum number of DataAttributeBindings to return. The service may return fewer than this value. If unspecified, at most 10 DataAttributeBindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, Optional. Page token received from a previous ListDataAttributeBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributeBindings 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:
-
-    { # List DataAttributeBindings response.
-  "dataAttributeBindings": [ # DataAttributeBindings under the given parent Location.
-    { # DataAttributeBinding represents binding of attributes to resources. Eg: Bind 'CustomerInfo' entity with 'PII' attribute.
-      "attributes": [ # Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
-        "A String",
-      ],
-      "createTime": "A String", # Output only. The time when the DataAttributeBinding was created.
-      "description": "A String", # Optional. Description of the DataAttributeBinding.
-      "displayName": "A String", # Optional. User friendly display name.
-      "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. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
-      "labels": { # Optional. User-defined labels for the DataAttributeBinding.
-        "a_key": "A String",
-      },
-      "name": "A String", # Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
-      "paths": [ # Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
-        { # Represents a subresource of the given resource, and associated bindings with it. Currently supported subresources are column and partition schema fields within a table.
-          "attributes": [ # Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
-            "A String",
-          ],
-          "name": "A String", # Required. The name identifier of the path. Nested columns should be of the form: 'address.city'.
-        },
-      ],
-      "resource": "A String", # Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.
-      "uid": "A String", # Output only. System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.
-      "updateTime": "A String", # Output only. The time when the DataAttributeBinding was last updated.
-    },
-  ],
-  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
-  "unreachableLocations": [ # Locations that could not be reached.
-    "A String",
-  ],
-}
-
- -
- list_next(previous_request, previous_response) -
Retrieves the next page of results.
-
-Args:
-  previous_request: The request for the previous page. (required)
-  previous_response: The response from the request for the previous page. (required)
-
-Returns:
-  A request object that you can call 'execute()' on to request the next
-  page. Returns None if there are no more items in the collection.
-
-
- -
- patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None) -
Updates a DataAttributeBinding resource.
-
-Args:
-  name: string, Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # DataAttributeBinding represents binding of attributes to resources. Eg: Bind 'CustomerInfo' entity with 'PII' attribute.
-  "attributes": [ # Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
-    "A String",
-  ],
-  "createTime": "A String", # Output only. The time when the DataAttributeBinding was created.
-  "description": "A String", # Optional. Description of the DataAttributeBinding.
-  "displayName": "A String", # Optional. User friendly display name.
-  "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. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.
-  "labels": { # Optional. User-defined labels for the DataAttributeBinding.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}
-  "paths": [ # Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.
-    { # Represents a subresource of the given resource, and associated bindings with it. Currently supported subresources are column and partition schema fields within a table.
-      "attributes": [ # Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}
-        "A String",
-      ],
-      "name": "A String", # Required. The name identifier of the path. Nested columns should be of the form: 'address.city'.
-    },
-  ],
-  "resource": "A String", # Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.
-  "uid": "A String", # Output only. System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the DataAttributeBinding was last updated.
-}
-
-  updateMask: string, Required. Mask of fields to update.
-  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
-
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/dataplex_v1.projects.locations.dataProducts.dataAssets.html b/docs/dyn/dataplex_v1.projects.locations.dataProducts.dataAssets.html
index 2405851bb6..d009f0db29 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataProducts.dataAssets.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataProducts.dataAssets.html
@@ -116,6 +116,7 @@ 

Method Details

"iamRoles": [ # Optional. IAM roles granted on the resource to this access group. Role name follows https://cloud.google.com/iam/docs/reference/rest/v1/roles.Example: [ "roles/bigquery.dataViewer" ] "A String", ], + "state": "A String", # Output only. The state of the iam role application. }, }, "createTime": "A String", # Output only. The time at which the data asset was created. @@ -217,6 +218,7 @@

Method Details

"iamRoles": [ # Optional. IAM roles granted on the resource to this access group. Role name follows https://cloud.google.com/iam/docs/reference/rest/v1/roles.Example: [ "roles/bigquery.dataViewer" ] "A String", ], + "state": "A String", # Output only. The state of the iam role application. }, }, "createTime": "A String", # Output only. The time at which the data asset was created. @@ -257,6 +259,7 @@

Method Details

"iamRoles": [ # Optional. IAM roles granted on the resource to this access group. Role name follows https://cloud.google.com/iam/docs/reference/rest/v1/roles.Example: [ "roles/bigquery.dataViewer" ] "A String", ], + "state": "A String", # Output only. The state of the iam role application. }, }, "createTime": "A String", # Output only. The time at which the data asset was created. @@ -303,6 +306,7 @@

Method Details

"iamRoles": [ # Optional. IAM roles granted on the resource to this access group. Role name follows https://cloud.google.com/iam/docs/reference/rest/v1/roles.Example: [ "roles/bigquery.dataViewer" ] "A String", ], + "state": "A String", # Output only. The state of the iam role application. }, }, "createTime": "A String", # Output only. The time at which the data asset was created. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataProducts.html b/docs/dyn/dataplex_v1.projects.locations.dataProducts.html index e270bc6f24..5a16eaa08c 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataProducts.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataProducts.html @@ -135,6 +135,9 @@

Method Details

}, "accessGroups": { # Optional. Data product access groups by access group id as key. If data product is used only for packaging data assets, then access groups may be empty. However, if a data product is used for sharing data assets, then at least one access group must be specified.Example: { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts@example.com" } } } "a_key": { # Custom user defined access groups at the data product level. These are used for granting different levels of access (IAM roles) on the individual data product's data assets. + "defaultIamRoleConfig": { # Default IAM role configuration for an access group. # Optional. Default IAM role configuration to be applied on the data assets associated with this data product, for this access group. + "role": "A String", # Optional. The IAM role resource name to be applied as default. Example: "roles/bigquery.dataViewer". + }, "description": "A String", # Optional. Description of the access group. "displayName": "A String", # Required. User friendly display name of the access group. Eg. "Analyst", "Developer", etc. "id": "A String", # Required. Unique identifier of the access group within the data product. User defined. Eg. "analyst", "developer", etc. @@ -251,6 +254,9 @@

Method Details

}, "accessGroups": { # Optional. Data product access groups by access group id as key. If data product is used only for packaging data assets, then access groups may be empty. However, if a data product is used for sharing data assets, then at least one access group must be specified.Example: { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts@example.com" } } } "a_key": { # Custom user defined access groups at the data product level. These are used for granting different levels of access (IAM roles) on the individual data product's data assets. + "defaultIamRoleConfig": { # Default IAM role configuration for an access group. # Optional. Default IAM role configuration to be applied on the data assets associated with this data product, for this access group. + "role": "A String", # Optional. The IAM role resource name to be applied as default. Example: "roles/bigquery.dataViewer". + }, "description": "A String", # Optional. Description of the access group. "displayName": "A String", # Required. User friendly display name of the access group. Eg. "Analyst", "Developer", etc. "id": "A String", # Required. Unique identifier of the access group within the data product. User defined. Eg. "analyst", "developer", etc. @@ -354,6 +360,9 @@

Method Details

}, "accessGroups": { # Optional. Data product access groups by access group id as key. If data product is used only for packaging data assets, then access groups may be empty. However, if a data product is used for sharing data assets, then at least one access group must be specified.Example: { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts@example.com" } } } "a_key": { # Custom user defined access groups at the data product level. These are used for granting different levels of access (IAM roles) on the individual data product's data assets. + "defaultIamRoleConfig": { # Default IAM role configuration for an access group. # Optional. Default IAM role configuration to be applied on the data assets associated with this data product, for this access group. + "role": "A String", # Optional. The IAM role resource name to be applied as default. Example: "roles/bigquery.dataViewer". + }, "description": "A String", # Optional. Description of the access group. "displayName": "A String", # Required. User friendly display name of the access group. Eg. "Analyst", "Developer", etc. "id": "A String", # Required. Unique identifier of the access group within the data product. User defined. Eg. "analyst", "developer", etc. @@ -418,6 +427,9 @@

Method Details

}, "accessGroups": { # Optional. Data product access groups by access group id as key. If data product is used only for packaging data assets, then access groups may be empty. However, if a data product is used for sharing data assets, then at least one access group must be specified.Example: { "analyst": { "id": "analyst", "displayName": "Analyst", "description": "Access group for analysts", "principal": { "googleGroup": "analysts@example.com" } } } "a_key": { # Custom user defined access groups at the data product level. These are used for granting different levels of access (IAM roles) on the individual data product's data assets. + "defaultIamRoleConfig": { # Default IAM role configuration for an access group. # Optional. Default IAM role configuration to be applied on the data assets associated with this data product, for this access group. + "role": "A String", # Optional. The IAM role resource name to be applied as default. Example: "roles/bigquery.dataViewer". + }, "description": "A String", # Optional. Description of the access group. "displayName": "A String", # Required. User friendly display name of the access group. Eg. "Analyst", "Developer", etc. "id": "A String", # Required. Unique identifier of the access group within the data product. User defined. Eg. "analyst", "developer", etc. diff --git a/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.attributes.html b/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.attributes.html index 106af25b8d..6aeef3e2cf 100644 --- a/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.attributes.html +++ b/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.attributes.html @@ -77,27 +77,9 @@

Instance Methods

close()

Close httplib2 connections.

-

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

-

Create a DataAttribute resource.

-

- delete(name, etag=None, x__xgafv=None)

-

Deletes a Data Attribute resource.

-

- get(name, x__xgafv=None)

-

Retrieves a Data Attribute resource.

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

-

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

-

Lists Data Attribute resources in a DataTaxonomy.

-

- list_next(previous_request, previous_response)

-

Retrieves the next page of results.

-

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

-

Updates a DataAttribute resource.

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.

@@ -110,159 +92,6 @@

Method Details

Close httplib2 connections.
-
- create(parent, body=None, dataAttributeId=None, validateOnly=None, x__xgafv=None) -
Create a DataAttribute resource.
-
-Args:
-  parent: string, Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id} (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Denotes one dataAttribute in a dataTaxonomy, for example, PII. DataAttribute resources can be defined in a hierarchy. A single dataAttribute resource can contain specs of multiple types PII - ResourceAccessSpec : - readers :foo@bar.com - DataAccessSpec : - readers :bar@foo.com
-  "attributeCount": 42, # Output only. The number of child attributes present for this attribute.
-  "createTime": "A String", # Output only. The time when the DataAttribute was created.
-  "dataAccessSpec": { # DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access. # Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).
-    "readers": [ # Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.
-      "A String",
-    ],
-  },
-  "description": "A String", # Optional. Description of the DataAttribute.
-  "displayName": "A String", # Optional. User friendly display name.
-  "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.
-  "labels": { # Optional. User-defined labels for the DataAttribute.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
-  "parentId": "A String", # Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4
-  "resourceAccessSpec": { # ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table. # Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
-    "owners": [ # Optional. The set of principals to be granted owner role on the resource.
-      "A String",
-    ],
-    "readers": [ # Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.
-      "A String",
-    ],
-    "writers": [ # Optional. The set of principals to be granted writer role on the resource.
-      "A String",
-    ],
-  },
-  "uid": "A String", # Output only. System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the DataAttribute was last updated.
-}
-
-  dataAttributeId: string, Required. DataAttribute 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 DataTaxonomy.
-  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- delete(name, etag=None, x__xgafv=None) -
Deletes a Data Attribute resource.
-
-Args:
-  name: string, Required. The resource name of the DataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id} (required)
-  etag: string, Optional. If the client provided etag value does not match the current etag value, the DeleteDataAttribute method returns an ABORTED error response.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- get(name, x__xgafv=None) -
Retrieves a Data Attribute resource.
-
-Args:
-  name: string, Required. The resource name of the dataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id} (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # Denotes one dataAttribute in a dataTaxonomy, for example, PII. DataAttribute resources can be defined in a hierarchy. A single dataAttribute resource can contain specs of multiple types PII - ResourceAccessSpec : - readers :foo@bar.com - DataAccessSpec : - readers :bar@foo.com
-  "attributeCount": 42, # Output only. The number of child attributes present for this attribute.
-  "createTime": "A String", # Output only. The time when the DataAttribute was created.
-  "dataAccessSpec": { # DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access. # Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).
-    "readers": [ # Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.
-      "A String",
-    ],
-  },
-  "description": "A String", # Optional. Description of the DataAttribute.
-  "displayName": "A String", # Optional. User friendly display name.
-  "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.
-  "labels": { # Optional. User-defined labels for the DataAttribute.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
-  "parentId": "A String", # Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4
-  "resourceAccessSpec": { # ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table. # Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
-    "owners": [ # Optional. The set of principals to be granted owner role on the resource.
-      "A String",
-    ],
-    "readers": [ # Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.
-      "A String",
-    ],
-    "writers": [ # Optional. The set of principals to be granted writer role on the resource.
-      "A String",
-    ],
-  },
-  "uid": "A String", # Output only. System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the DataAttribute was last updated.
-}
-
-
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.
@@ -311,149 +140,6 @@ 

Method Details

}
-
- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists Data Attribute resources in a DataTaxonomy.
-
-Args:
-  parent: string, Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id} (required)
-  filter: string, Optional. Filter request.
-  orderBy: string, Optional. Order by fields for the result.
-  pageSize: integer, Optional. Maximum number of DataAttributes to return. The service may return fewer than this value. If unspecified, at most 10 dataAttributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, Optional. Page token received from a previous ListDataAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributes 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:
-
-    { # List DataAttributes response.
-  "dataAttributes": [ # DataAttributes under the given parent DataTaxonomy.
-    { # Denotes one dataAttribute in a dataTaxonomy, for example, PII. DataAttribute resources can be defined in a hierarchy. A single dataAttribute resource can contain specs of multiple types PII - ResourceAccessSpec : - readers :foo@bar.com - DataAccessSpec : - readers :bar@foo.com
-      "attributeCount": 42, # Output only. The number of child attributes present for this attribute.
-      "createTime": "A String", # Output only. The time when the DataAttribute was created.
-      "dataAccessSpec": { # DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access. # Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).
-        "readers": [ # Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.
-          "A String",
-        ],
-      },
-      "description": "A String", # Optional. Description of the DataAttribute.
-      "displayName": "A String", # Optional. User friendly display name.
-      "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.
-      "labels": { # Optional. User-defined labels for the DataAttribute.
-        "a_key": "A String",
-      },
-      "name": "A String", # Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
-      "parentId": "A String", # Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4
-      "resourceAccessSpec": { # ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table. # Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
-        "owners": [ # Optional. The set of principals to be granted owner role on the resource.
-          "A String",
-        ],
-        "readers": [ # Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.
-          "A String",
-        ],
-        "writers": [ # Optional. The set of principals to be granted writer role on the resource.
-          "A String",
-        ],
-      },
-      "uid": "A String", # Output only. System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.
-      "updateTime": "A String", # Output only. The time when the DataAttribute was last updated.
-    },
-  ],
-  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
-  "unreachableLocations": [ # Locations that could not be reached.
-    "A String",
-  ],
-}
-
- -
- list_next(previous_request, previous_response) -
Retrieves the next page of results.
-
-Args:
-  previous_request: The request for the previous page. (required)
-  previous_response: The response from the request for the previous page. (required)
-
-Returns:
-  A request object that you can call 'execute()' on to request the next
-  page. Returns None if there are no more items in the collection.
-
-
- -
- patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None) -
Updates a DataAttribute resource.
-
-Args:
-  name: string, Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # Denotes one dataAttribute in a dataTaxonomy, for example, PII. DataAttribute resources can be defined in a hierarchy. A single dataAttribute resource can contain specs of multiple types PII - ResourceAccessSpec : - readers :foo@bar.com - DataAccessSpec : - readers :bar@foo.com
-  "attributeCount": 42, # Output only. The number of child attributes present for this attribute.
-  "createTime": "A String", # Output only. The time when the DataAttribute was created.
-  "dataAccessSpec": { # DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access. # Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables).
-    "readers": [ # Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.
-      "A String",
-    ],
-  },
-  "description": "A String", # Optional. Description of the DataAttribute.
-  "displayName": "A String", # Optional. User friendly display name.
-  "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.
-  "labels": { # Optional. User-defined labels for the DataAttribute.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.
-  "parentId": "A String", # Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4
-  "resourceAccessSpec": { # ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table. # Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table).
-    "owners": [ # Optional. The set of principals to be granted owner role on the resource.
-      "A String",
-    ],
-    "readers": [ # Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.
-      "A String",
-    ],
-    "writers": [ # Optional. The set of principals to be granted writer role on the resource.
-      "A String",
-    ],
-  },
-  "uid": "A String", # Output only. System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the DataAttribute was last updated.
-}
-
-  updateMask: string, Required. Mask of fields to update.
-  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
-
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/dataplex_v1.projects.locations.dataTaxonomies.html b/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.html
index f8b833a6ad..3c783450e3 100644
--- a/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.html
+++ b/docs/dyn/dataplex_v1.projects.locations.dataTaxonomies.html
@@ -82,27 +82,9 @@ 

Instance Methods

close()

Close httplib2 connections.

-

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

-

Create a DataTaxonomy resource.

-

- delete(name, etag=None, x__xgafv=None)

-

Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.

-

- get(name, x__xgafv=None)

-

Retrieves a DataTaxonomy resource.

getIamPolicy(resource, options_requestedPolicyVersion=None, x__xgafv=None)

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

-

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

-

Lists DataTaxonomy resources in a project and location.

-

- list_next(previous_request, previous_response)

-

Retrieves the next page of results.

-

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

-

Updates a DataTaxonomy resource.

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,127 +97,6 @@

Method Details

Close httplib2 connections.
-
- create(parent, body=None, dataTaxonomyId=None, validateOnly=None, x__xgafv=None) -
Create a DataTaxonomy resource.
-
-Args:
-  parent: string, A parameter (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # DataTaxonomy represents a set of hierarchical DataAttributes resources, grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes to manage PII data. It is defined at project level.
-  "attributeCount": 42, # Output only. The number of attributes in the DataTaxonomy.
-  "classCount": 42, # Output only. The number of classes in the DataTaxonomy.
-  "createTime": "A String", # Output only. The time when the DataTaxonomy was created.
-  "description": "A String", # Optional. Description of the DataTaxonomy.
-  "displayName": "A String", # Optional. User friendly display name.
-  "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.
-  "labels": { # Optional. User-defined labels for the DataTaxonomy.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.
-  "uid": "A String", # Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the DataTaxonomy was last updated.
-}
-
-  dataTaxonomyId: string, Required. DataTaxonomy 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 Project.
-  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- delete(name, etag=None, x__xgafv=None) -
Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.
-
-Args:
-  name: string, Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id} (required)
-  etag: string, Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
- -
- get(name, x__xgafv=None) -
Retrieves a DataTaxonomy resource.
-
-Args:
-  name: string, A parameter (required)
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # DataTaxonomy represents a set of hierarchical DataAttributes resources, grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes to manage PII data. It is defined at project level.
-  "attributeCount": 42, # Output only. The number of attributes in the DataTaxonomy.
-  "classCount": 42, # Output only. The number of classes in the DataTaxonomy.
-  "createTime": "A String", # Output only. The time when the DataTaxonomy was created.
-  "description": "A String", # Optional. Description of the DataTaxonomy.
-  "displayName": "A String", # Optional. User friendly display name.
-  "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.
-  "labels": { # Optional. User-defined labels for the DataTaxonomy.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.
-  "uid": "A String", # Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the DataTaxonomy was last updated.
-}
-
-
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.
@@ -284,117 +145,6 @@ 

Method Details

}
-
- list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists DataTaxonomy resources in a project and location.
-
-Args:
-  parent: string, Required. The resource name of the DataTaxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region. (required)
-  filter: string, Optional. Filter request.
-  orderBy: string, Optional. Order by fields for the result.
-  pageSize: integer, Optional. Maximum number of DataTaxonomies to return. The service may return fewer than this value. If unspecified, at most 10 DataTaxonomies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
-  pageToken: string, Optional. Page token received from a previous ListDataTaxonomies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataTaxonomies 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:
-
-    { # List DataTaxonomies response.
-  "dataTaxonomies": [ # DataTaxonomies under the given parent location.
-    { # DataTaxonomy represents a set of hierarchical DataAttributes resources, grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes to manage PII data. It is defined at project level.
-      "attributeCount": 42, # Output only. The number of attributes in the DataTaxonomy.
-      "classCount": 42, # Output only. The number of classes in the DataTaxonomy.
-      "createTime": "A String", # Output only. The time when the DataTaxonomy was created.
-      "description": "A String", # Optional. Description of the DataTaxonomy.
-      "displayName": "A String", # Optional. User friendly display name.
-      "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.
-      "labels": { # Optional. User-defined labels for the DataTaxonomy.
-        "a_key": "A String",
-      },
-      "name": "A String", # Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.
-      "uid": "A String", # Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.
-      "updateTime": "A String", # Output only. The time when the DataTaxonomy was last updated.
-    },
-  ],
-  "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more results in the list.
-  "unreachableLocations": [ # Locations that could not be reached.
-    "A String",
-  ],
-}
-
- -
- list_next(previous_request, previous_response) -
Retrieves the next page of results.
-
-Args:
-  previous_request: The request for the previous page. (required)
-  previous_response: The response from the request for the previous page. (required)
-
-Returns:
-  A request object that you can call 'execute()' on to request the next
-  page. Returns None if there are no more items in the collection.
-
-
- -
- patch(name, body=None, updateMask=None, validateOnly=None, x__xgafv=None) -
Updates a DataTaxonomy resource.
-
-Args:
-  name: string, Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}. (required)
-  body: object, The request body.
-    The object takes the form of:
-
-{ # DataTaxonomy represents a set of hierarchical DataAttributes resources, grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes to manage PII data. It is defined at project level.
-  "attributeCount": 42, # Output only. The number of attributes in the DataTaxonomy.
-  "classCount": 42, # Output only. The number of classes in the DataTaxonomy.
-  "createTime": "A String", # Output only. The time when the DataTaxonomy was created.
-  "description": "A String", # Optional. Description of the DataTaxonomy.
-  "displayName": "A String", # Optional. User friendly display name.
-  "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.
-  "labels": { # Optional. User-defined labels for the DataTaxonomy.
-    "a_key": "A String",
-  },
-  "name": "A String", # Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.
-  "uid": "A String", # Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.
-  "updateTime": "A String", # Output only. The time when the DataTaxonomy was last updated.
-}
-
-  updateMask: string, Required. Mask of fields to update.
-  validateOnly: boolean, Optional. Only validate the request, but do not perform mutations. The default is false.
-  x__xgafv: string, V1 error format.
-    Allowed values
-      1 - v1 error format
-      2 - v2 error format
-
-Returns:
-  An object of the form:
-
-    { # This resource represents a long-running operation that is the result of a network API call.
-  "done": True or False, # If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.
-  "error": { # The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each Status message contains three pieces of data: error code, error message, and error details.You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
-    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
-    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
-      {
-        "a_key": "", # Properties of the object. Contains field @type with type URL.
-      },
-    ],
-    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
-  },
-  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.
-  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.
-    "a_key": "", # Properties of the object. Contains field @type with type URL.
-  },
-}
-
-
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/dataplex_v1.projects.locations.html b/docs/dyn/dataplex_v1.projects.locations.html
index 4ecd938b70..a3411a787e 100644
--- a/docs/dyn/dataplex_v1.projects.locations.html
+++ b/docs/dyn/dataplex_v1.projects.locations.html
@@ -74,6 +74,11 @@
 
 

Cloud Dataplex API . projects . locations

Instance Methods

+

+ agentTasks() +

+

Returns the agentTasks Resource.

+

aspectTypes()

diff --git a/googleapiclient/discovery_cache/documents/dataplex.v1.json b/googleapiclient/discovery_cache/documents/dataplex.v1.json index e0f3b25de8..be86729e48 100644 --- a/googleapiclient/discovery_cache/documents/dataplex.v1.json +++ b/googleapiclient/discovery_cache/documents/dataplex.v1.json @@ -1100,6 +1100,100 @@ } }, "resources": { +"agentTasks": { +"methods": { +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentTasks/{agentTasksId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataplex.projects.locations.agentTasks.getIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentTasks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:getIamPolicy", +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentTasks/{agentTasksId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataplex.projects.locations.agentTasks.setIamPolicy", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentTasks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" +}, +"response": { +"$ref": "GoogleIamV1Policy" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +}, +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/agentTasks/{agentTasksId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataplex.projects.locations.agentTasks.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/agentTasks/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, +"response": { +"$ref": "GoogleIamV1TestIamPermissionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] +} +} +}, "aspectTypes": { "methods": { "create": { @@ -1674,105 +1768,6 @@ }, "dataAttributeBindings": { "methods": { -"create": { -"deprecated": true, -"description": "Create a DataAttributeBinding resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings", -"httpMethod": "POST", -"id": "dataplex.projects.locations.dataAttributeBindings.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"dataAttributeBindingId": { -"description": "Required. DataAttributeBinding 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 Location.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+parent}/dataAttributeBindings", -"request": { -"$ref": "GoogleCloudDataplexV1DataAttributeBinding" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"delete": { -"deprecated": true, -"description": "Deletes a DataAttributeBinding resource. All attributes within the DataAttributeBinding must be deleted before the DataAttributeBinding can be deleted.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}", -"httpMethod": "DELETE", -"id": "dataplex.projects.locations.dataAttributeBindings.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"etag": { -"description": "Required. If the client provided etag value does not match the current etag value, the DeleteDataAttributeBindingRequest method returns an ABORTED error response. Etags must be used when calling the DeleteDataAttributeBinding.", -"location": "query", -"type": "string" -}, -"name": { -"description": "Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"get": { -"deprecated": true, -"description": "Retrieves a DataAttributeBinding resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}", -"httpMethod": "GET", -"id": "dataplex.projects.locations.dataAttributeBindings.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the DataAttributeBinding: projects/{project_number}/locations/{location_id}/dataAttributeBindings/{data_attribute_binding_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleCloudDataplexV1DataAttributeBinding" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:getIamPolicy", @@ -1805,95 +1800,6 @@ "https://www.googleapis.com/auth/dataplex.read-write" ] }, -"list": { -"deprecated": true, -"description": "Lists DataAttributeBinding resources in a project and location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings", -"httpMethod": "GET", -"id": "dataplex.projects.locations.dataAttributeBindings.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. Filter request. Filter using resource: filter=resource:\"resource-name\" Filter using attribute: filter=attributes:\"attribute-name\" Filter using attribute in paths list: filter=paths.attributes:\"attribute-name\"", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. Order by fields for the result.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Maximum number of DataAttributeBindings to return. The service may return fewer than this value. If unspecified, at most 10 DataAttributeBindings will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. Page token received from a previous ListDataAttributeBindings call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributeBindings must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the Location: projects/{project_number}/locations/{location_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/dataAttributeBindings", -"response": { -"$ref": "GoogleCloudDataplexV1ListDataAttributeBindingsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"patch": { -"deprecated": true, -"description": "Updates a DataAttributeBinding resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}", -"httpMethod": "PATCH", -"id": "dataplex.projects.locations.dataAttributeBindings.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataAttributeBindings/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. Mask of fields to update.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudDataplexV1DataAttributeBinding" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, "setIamPolicy": { "description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataAttributeBindings/{dataAttributeBindingsId}:setIamPolicy", @@ -3368,412 +3274,33 @@ "parent": { "description": "Required. The resource name of the parent environment: projects/{project}/locations/{location_id}/dataScans/{data_scan_id} where project refers to a project_id or project_number and location_id refers to a Google Cloud region.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/jobs", -"response": { -"$ref": "GoogleCloudDataplexV1ListDataScanJobsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/cloud-platform.read-only", -"https://www.googleapis.com/auth/dataplex.read-write", -"https://www.googleapis.com/auth/dataplex.readonly" -] -} -} -} -} -}, -"dataTaxonomies": { -"methods": { -"create": { -"deprecated": true, -"description": "Create a DataTaxonomy resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies", -"httpMethod": "POST", -"id": "dataplex.projects.locations.dataTaxonomies.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"dataTaxonomyId": { -"description": "Required. DataTaxonomy 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 Project.", -"location": "query", -"type": "string" -}, -"parent": { -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+parent}/dataTaxonomies", -"request": { -"$ref": "GoogleCloudDataplexV1DataTaxonomy" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"delete": { -"deprecated": true, -"description": "Deletes a DataTaxonomy resource. All attributes within the DataTaxonomy must be deleted before the DataTaxonomy can be deleted.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}", -"httpMethod": "DELETE", -"id": "dataplex.projects.locations.dataTaxonomies.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"etag": { -"description": "Optional. If the client provided etag value does not match the current etag value,the DeleteDataTaxonomy method returns an ABORTED error.", -"location": "query", -"type": "string" -}, -"name": { -"description": "Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"get": { -"deprecated": true, -"description": "Retrieves a DataTaxonomy resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}", -"httpMethod": "GET", -"id": "dataplex.projects.locations.dataTaxonomies.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleCloudDataplexV1DataTaxonomy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"getIamPolicy": { -"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:getIamPolicy", -"httpMethod": "GET", -"id": "dataplex.projects.locations.dataTaxonomies.getIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"options.requestedPolicyVersion": { -"description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", -"format": "int32", -"location": "query", -"type": "integer" -}, -"resource": { -"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:getIamPolicy", -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"list": { -"deprecated": true, -"description": "Lists DataTaxonomy resources in a project and location.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies", -"httpMethod": "GET", -"id": "dataplex.projects.locations.dataTaxonomies.list", -"parameterOrder": [ -"parent" -], -"parameters": { -"filter": { -"description": "Optional. Filter request.", -"location": "query", -"type": "string" -}, -"orderBy": { -"description": "Optional. Order by fields for the result.", -"location": "query", -"type": "string" -}, -"pageSize": { -"description": "Optional. Maximum number of DataTaxonomies to return. The service may return fewer than this value. If unspecified, at most 10 DataTaxonomies will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" -}, -"pageToken": { -"description": "Optional. Page token received from a previous ListDataTaxonomies call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataTaxonomies must match the call that provided the page token.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the DataTaxonomy location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+parent}/dataTaxonomies", -"response": { -"$ref": "GoogleCloudDataplexV1ListDataTaxonomiesResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"patch": { -"deprecated": true, -"description": "Updates a DataTaxonomy resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}", -"httpMethod": "PATCH", -"id": "dataplex.projects.locations.dataTaxonomies.patch", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", -"required": true, -"type": "string" -}, -"updateMask": { -"description": "Required. Mask of fields to update.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudDataplexV1DataTaxonomy" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"setIamPolicy": { -"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:setIamPolicy", -"httpMethod": "POST", -"id": "dataplex.projects.locations.dataTaxonomies.setIamPolicy", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:setIamPolicy", -"request": { -"$ref": "GoogleIamV1SetIamPolicyRequest" -}, -"response": { -"$ref": "GoogleIamV1Policy" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"testIamPermissions": { -"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:testIamPermissions", -"httpMethod": "POST", -"id": "dataplex.projects.locations.dataTaxonomies.testIamPermissions", -"parameterOrder": [ -"resource" -], -"parameters": { -"resource": { -"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+resource}:testIamPermissions", -"request": { -"$ref": "GoogleIamV1TestIamPermissionsRequest" -}, -"response": { -"$ref": "GoogleIamV1TestIamPermissionsResponse" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -} -}, -"resources": { -"attributes": { -"methods": { -"create": { -"deprecated": true, -"description": "Create a DataAttribute resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes", -"httpMethod": "POST", -"id": "dataplex.projects.locations.dataTaxonomies.attributes.create", -"parameterOrder": [ -"parent" -], -"parameters": { -"dataAttributeId": { -"description": "Required. DataAttribute 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 DataTaxonomy.", -"location": "query", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the parent data taxonomy projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", -"required": true, -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" -} -}, -"path": "v1/{+parent}/attributes", -"request": { -"$ref": "GoogleCloudDataplexV1DataAttribute" -}, -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"delete": { -"deprecated": true, -"description": "Deletes a Data Attribute resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}", -"httpMethod": "DELETE", -"id": "dataplex.projects.locations.dataTaxonomies.attributes.delete", -"parameterOrder": [ -"name" -], -"parameters": { -"etag": { -"description": "Optional. If the client provided etag value does not match the current etag value, the DeleteDataAttribute method returns an ABORTED error response.", -"location": "query", -"type": "string" -}, -"name": { -"description": "Required. The resource name of the DataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$", -"required": true, -"type": "string" -} -}, -"path": "v1/{+name}", -"response": { -"$ref": "GoogleLongrunningOperation" -}, -"scopes": [ -"https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" -] -}, -"get": { -"deprecated": true, -"description": "Retrieves a Data Attribute resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}", -"httpMethod": "GET", -"id": "dataplex.projects.locations.dataTaxonomies.attributes.get", -"parameterOrder": [ -"name" -], -"parameters": { -"name": { -"description": "Required. The resource name of the dataAttribute: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}", -"location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataScans/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+name}", +"path": "v1/{+parent}/jobs", "response": { -"$ref": "GoogleCloudDataplexV1DataAttribute" +"$ref": "GoogleCloudDataplexV1ListDataScanJobsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", -"https://www.googleapis.com/auth/dataplex.read-write" +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/dataplex.read-write", +"https://www.googleapis.com/auth/dataplex.readonly" ] +} +} +} +} }, +"dataTaxonomies": { +"methods": { "getIamPolicy": { "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:getIamPolicy", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:getIamPolicy", "httpMethod": "GET", -"id": "dataplex.projects.locations.dataTaxonomies.attributes.getIamPolicy", +"id": "dataplex.projects.locations.dataTaxonomies.getIamPolicy", "parameterOrder": [ "resource" ], @@ -3787,7 +3314,7 @@ "resource": { "description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", -"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$", +"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", "required": true, "type": "string" } @@ -3801,89 +3328,94 @@ "https://www.googleapis.com/auth/dataplex.read-write" ] }, -"list": { -"deprecated": true, -"description": "Lists Data Attribute resources in a DataTaxonomy.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes", -"httpMethod": "GET", -"id": "dataplex.projects.locations.dataTaxonomies.attributes.list", +"setIamPolicy": { +"description": "Sets the access control policy on the specified resource. Replaces any existing policy.Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:setIamPolicy", +"httpMethod": "POST", +"id": "dataplex.projects.locations.dataTaxonomies.setIamPolicy", "parameterOrder": [ -"parent" +"resource" ], "parameters": { -"filter": { -"description": "Optional. Filter request.", -"location": "query", +"resource": { +"description": "REQUIRED: The resource for which the policy is being specified. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", +"required": true, "type": "string" +} }, -"orderBy": { -"description": "Optional. Order by fields for the result.", -"location": "query", -"type": "string" +"path": "v1/{+resource}:setIamPolicy", +"request": { +"$ref": "GoogleIamV1SetIamPolicyRequest" }, -"pageSize": { -"description": "Optional. Maximum number of DataAttributes to return. The service may return fewer than this value. If unspecified, at most 10 dataAttributes will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.", -"format": "int32", -"location": "query", -"type": "integer" +"response": { +"$ref": "GoogleIamV1Policy" }, -"pageToken": { -"description": "Optional. Page token received from a previous ListDataAttributes call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListDataAttributes must match the call that provided the page token.", -"location": "query", -"type": "string" +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dataplex.read-write" +] }, -"parent": { -"description": "Required. The resource name of the DataTaxonomy: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}", +"testIamPermissions": { +"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}:testIamPermissions", +"httpMethod": "POST", +"id": "dataplex.projects.locations.dataTaxonomies.testIamPermissions", +"parameterOrder": [ +"resource" +], +"parameters": { +"resource": { +"description": "REQUIRED: The resource for which the policy detail is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+$", "required": true, "type": "string" } }, -"path": "v1/{+parent}/attributes", +"path": "v1/{+resource}:testIamPermissions", +"request": { +"$ref": "GoogleIamV1TestIamPermissionsRequest" +}, "response": { -"$ref": "GoogleCloudDataplexV1ListDataAttributesResponse" +"$ref": "GoogleIamV1TestIamPermissionsResponse" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/dataplex.read-write" ] +} }, -"patch": { -"deprecated": true, -"description": "Updates a DataAttribute resource.", -"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}", -"httpMethod": "PATCH", -"id": "dataplex.projects.locations.dataTaxonomies.attributes.patch", +"resources": { +"attributes": { +"methods": { +"getIamPolicy": { +"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", +"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataTaxonomies/{dataTaxonomiesId}/attributes/{attributesId}:getIamPolicy", +"httpMethod": "GET", +"id": "dataplex.projects.locations.dataTaxonomies.attributes.getIamPolicy", "parameterOrder": [ -"name" +"resource" ], "parameters": { -"name": { -"description": "Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.", +"options.requestedPolicyVersion": { +"description": "Optional. The maximum policy version that will be used to format the policy.Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected.Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset.The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1.To learn which resources support conditions in their IAM policies, see the IAM documentation (https://cloud.google.com/iam/help/conditions/resource-policies).", +"format": "int32", +"location": "query", +"type": "integer" +}, +"resource": { +"description": "REQUIRED: The resource for which the policy is being requested. See Resource names (https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/dataTaxonomies/[^/]+/attributes/[^/]+$", "required": true, "type": "string" -}, -"updateMask": { -"description": "Required. Mask of fields to update.", -"format": "google-fieldmask", -"location": "query", -"type": "string" -}, -"validateOnly": { -"description": "Optional. Only validate the request, but do not perform mutations. The default is false.", -"location": "query", -"type": "boolean" } }, -"path": "v1/{+name}", -"request": { -"$ref": "GoogleCloudDataplexV1DataAttribute" -}, +"path": "v1/{+resource}:getIamPolicy", "response": { -"$ref": "GoogleLongrunningOperation" +"$ref": "GoogleIamV1Policy" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -8044,7 +7576,7 @@ } } }, -"revision": "20260917", +"revision": "20260929", "rootUrl": "https://dataplex.googleapis.com/", "schemas": { "Empty": { @@ -9238,284 +8770,122 @@ "entry": { "$ref": "GoogleCloudDataplexV1Entry", "description": "Required. Entry resource." -}, -"entryId": { -"description": "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.", -"type": "string" -}, -"parent": { -"description": "Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1CreateGlossaryCategoryRequest": { -"description": "Creates a new GlossaryCategory under the specified Glossary.", -"id": "GoogleCloudDataplexV1CreateGlossaryCategoryRequest", -"properties": { -"category": { -"$ref": "GoogleCloudDataplexV1GlossaryCategory", -"description": "Required. The GlossaryCategory to create." -}, -"categoryId": { -"description": "Required. GlossaryCategory identifier.", -"type": "string" -}, -"parent": { -"description": "Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1CreateGlossaryRequest": { -"description": "Create Glossary Request", -"id": "GoogleCloudDataplexV1CreateGlossaryRequest", -"properties": { -"glossary": { -"$ref": "GoogleCloudDataplexV1Glossary", -"description": "Required. The Glossary to create." -}, -"glossaryId": { -"description": "Required. Glossary ID: Glossary identifier.", -"type": "string" -}, -"parent": { -"description": "Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.", -"type": "string" -}, -"validateOnly": { -"description": "Optional. Validates the request without actually creating the Glossary. Default: false.", -"type": "boolean" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1CreateGlossaryTermRequest": { -"description": "Creates a new GlossaryTerm under the specified Glossary.", -"id": "GoogleCloudDataplexV1CreateGlossaryTermRequest", -"properties": { -"parent": { -"description": "Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.", -"type": "string" -}, -"term": { -"$ref": "GoogleCloudDataplexV1GlossaryTerm", -"description": "Required. The GlossaryTerm to create." -}, -"termId": { -"description": "Required. GlossaryTerm identifier.", -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1DataAccessSpec": { -"description": "DataAccessSpec holds the access control configuration to be enforced on data stored within resources (eg: rows, columns in BigQuery Tables). When associated with data, the data is only accessible to principals explicitly granted access through the DataAccessSpec. Principals with access to the containing resource are not implicitly granted access.", -"id": "GoogleCloudDataplexV1DataAccessSpec", -"properties": { -"readers": { -"description": "Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on data stored within resources.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1DataAsset": { -"description": "Represents a data asset resource that can be packaged and shared via a data product.", -"id": "GoogleCloudDataplexV1DataAsset", -"properties": { -"accessGroupConfigs": { -"additionalProperties": { -"$ref": "GoogleCloudDataplexV1DataAssetAccessGroupConfig" -}, -"description": "Optional. Access groups configurations for this data asset.The key is DataProduct.AccessGroup.id and the value is AccessGroupConfig.Example: { \"analyst\": { \"iamRoles\": [\"roles/bigquery.dataViewer\"] } } Currently, at most one IAM role is allowed per access group. For providing multiple predefined IAM roles, wrap them in a custom IAM role as per https://cloud.google.com/iam/docs/creating-custom-roles.", -"type": "object" -}, -"createTime": { -"description": "Output only. The time at which the data asset was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"etag": { -"description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", -"type": "string" -}, -"labels": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. User-defined labels for the data asset.Example: { \"environment\": \"production\", \"billing\": \"marketing-department\" } ", -"type": "object" -}, -"name": { -"description": "Identifier. Resource name of the data asset. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}", -"type": "string" -}, -"resource": { -"description": "Required. Immutable. Full resource name of the cloud resource represented by the data asset. This must follow https://cloud.google.com/iam/docs/full-resource-names. Example: //bigquery.googleapis.com/projects/my_project_123/datasets/dataset_456/tables/table_789 Only BigQuery tables and datasets are currently supported. Data asset creator must have getIamPolicy and setIamPolicy permissions on the resource. Data asset creator must also have resource specific get permission, for instance, bigquery.tables.get for BigQuery tables.", -"type": "string" -}, -"uid": { -"description": "Output only. System generated globally unique ID for the data asset. This ID will be different if the data asset is deleted and re-created with the same name.", -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. The time at which the data asset was last updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1DataAssetAccessGroupConfig": { -"description": "Configuration for access group inherited from the parent data product.", -"id": "GoogleCloudDataplexV1DataAssetAccessGroupConfig", -"properties": { -"iamRoles": { -"description": "Optional. IAM roles granted on the resource to this access group. Role name follows https://cloud.google.com/iam/docs/reference/rest/v1/roles.Example: [ \"roles/bigquery.dataViewer\" ]", -"items": { +}, +"entryId": { +"description": "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.", "type": "string" }, -"type": "array" +"parent": { +"description": "Required. The resource name of the parent Entry Group: projects/{project}/locations/{location}/entryGroups/{entry_group}.", +"type": "string" } }, "type": "object" }, -"GoogleCloudDataplexV1DataAttribute": { -"deprecated": true, -"description": "Denotes one dataAttribute in a dataTaxonomy, for example, PII. DataAttribute resources can be defined in a hierarchy. A single dataAttribute resource can contain specs of multiple types PII - ResourceAccessSpec : - readers :foo@bar.com - DataAccessSpec : - readers :bar@foo.com ", -"id": "GoogleCloudDataplexV1DataAttribute", +"GoogleCloudDataplexV1CreateGlossaryCategoryRequest": { +"description": "Creates a new GlossaryCategory under the specified Glossary.", +"id": "GoogleCloudDataplexV1CreateGlossaryCategoryRequest", "properties": { -"attributeCount": { -"description": "Output only. The number of child attributes present for this attribute.", -"format": "int32", -"readOnly": true, -"type": "integer" +"category": { +"$ref": "GoogleCloudDataplexV1GlossaryCategory", +"description": "Required. The GlossaryCategory to create." }, -"createTime": { -"description": "Output only. The time when the DataAttribute was created.", -"format": "google-datetime", -"readOnly": true, +"categoryId": { +"description": "Required. GlossaryCategory identifier.", "type": "string" }, -"dataAccessSpec": { -"$ref": "GoogleCloudDataplexV1DataAccessSpec", -"description": "Optional. Specified when applied to data stored on the resource (eg: rows, columns in BigQuery Tables)." -}, -"description": { -"description": "Optional. Description of the DataAttribute.", +"parent": { +"description": "Required. The parent resource where this GlossaryCategory will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where locationId refers to a Google Cloud region.", "type": "string" +} }, -"displayName": { -"description": "Optional. User friendly display name.", -"type": "string" +"type": "object" }, -"etag": { -"description": "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.", -"type": "string" +"GoogleCloudDataplexV1CreateGlossaryRequest": { +"description": "Create Glossary Request", +"id": "GoogleCloudDataplexV1CreateGlossaryRequest", +"properties": { +"glossary": { +"$ref": "GoogleCloudDataplexV1Glossary", +"description": "Required. The Glossary to create." }, -"labels": { -"additionalProperties": { +"glossaryId": { +"description": "Required. Glossary ID: Glossary identifier.", "type": "string" }, -"description": "Optional. User-defined labels for the DataAttribute.", -"type": "object" -}, -"name": { -"description": "Output only. The relative resource name of the dataAttribute, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}.", -"readOnly": true, +"parent": { +"description": "Required. The parent resource where this Glossary will be created. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.", "type": "string" }, -"parentId": { -"description": "Optional. The ID of the parent DataAttribute resource, should belong to the same data taxonomy. Circular dependency in parent chain is not valid. Maximum depth of the hierarchy allowed is 4. a -> b -> c -> d -> e, depth = 4", -"type": "string" +"validateOnly": { +"description": "Optional. Validates the request without actually creating the Glossary. Default: false.", +"type": "boolean" +} }, -"resourceAccessSpec": { -"$ref": "GoogleCloudDataplexV1ResourceAccessSpec", -"description": "Optional. Specified when applied to a resource (eg: Cloud Storage bucket, BigQuery dataset, BigQuery table)." +"type": "object" }, -"uid": { -"description": "Output only. System generated globally unique ID for the DataAttribute. This ID will be different if the DataAttribute is deleted and re-created with the same name.", -"readOnly": true, +"GoogleCloudDataplexV1CreateGlossaryTermRequest": { +"description": "Creates a new GlossaryTerm under the specified Glossary.", +"id": "GoogleCloudDataplexV1CreateGlossaryTermRequest", +"properties": { +"parent": { +"description": "Required. The parent resource where the GlossaryTerm will be created. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} where location_id refers to a Google Cloud region.", "type": "string" }, -"updateTime": { -"description": "Output only. The time when the DataAttribute was last updated.", -"format": "google-datetime", -"readOnly": true, +"term": { +"$ref": "GoogleCloudDataplexV1GlossaryTerm", +"description": "Required. The GlossaryTerm to create." +}, +"termId": { +"description": "Required. GlossaryTerm identifier.", "type": "string" } }, "type": "object" }, -"GoogleCloudDataplexV1DataAttributeBinding": { -"deprecated": true, -"description": "DataAttributeBinding represents binding of attributes to resources. Eg: Bind 'CustomerInfo' entity with 'PII' attribute.", -"id": "GoogleCloudDataplexV1DataAttributeBinding", +"GoogleCloudDataplexV1DataAsset": { +"description": "Represents a data asset resource that can be packaged and shared via a data product.", +"id": "GoogleCloudDataplexV1DataAsset", "properties": { -"attributes": { -"description": "Optional. List of attributes to be associated with the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}", -"items": { -"type": "string" +"accessGroupConfigs": { +"additionalProperties": { +"$ref": "GoogleCloudDataplexV1DataAssetAccessGroupConfig" }, -"type": "array" +"description": "Optional. Access groups configurations for this data asset.The key is DataProduct.AccessGroup.id and the value is AccessGroupConfig.Example: { \"analyst\": { \"iamRoles\": [\"roles/bigquery.dataViewer\"] } } Currently, at most one IAM role is allowed per access group. For providing multiple predefined IAM roles, wrap them in a custom IAM role as per https://cloud.google.com/iam/docs/creating-custom-roles.", +"type": "object" }, "createTime": { -"description": "Output only. The time when the DataAttributeBinding was created.", +"description": "Output only. The time at which the data asset was created.", "format": "google-datetime", "readOnly": true, "type": "string" }, -"description": { -"description": "Optional. Description of the DataAttributeBinding.", -"type": "string" -}, -"displayName": { -"description": "Optional. User friendly display name.", -"type": "string" -}, "etag": { -"description": "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. Etags must be used when calling the DeleteDataAttributeBinding and the UpdateDataAttributeBinding method.", +"description": "Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.", "type": "string" }, "labels": { "additionalProperties": { "type": "string" }, -"description": "Optional. User-defined labels for the DataAttributeBinding.", +"description": "Optional. User-defined labels for the data asset.Example: { \"environment\": \"production\", \"billing\": \"marketing-department\" } ", "type": "object" }, "name": { -"description": "Output only. The relative resource name of the Data Attribute Binding, of the form: projects/{project_number}/locations/{location}/dataAttributeBindings/{data_attribute_binding_id}", -"readOnly": true, +"description": "Identifier. Resource name of the data asset. Format: projects/{project_id_or_number}/locations/{location_id}/dataProducts/{data_product_id}/dataAssets/{data_asset_id}", "type": "string" }, -"paths": { -"description": "Optional. The list of paths for items within the associated resource (eg. columns and partitions within a table) along with attribute bindings.", -"items": { -"$ref": "GoogleCloudDataplexV1DataAttributeBindingPath" -}, -"type": "array" -}, "resource": { -"description": "Optional. Immutable. The resource name of the resource that is associated to attributes. Presently, only entity resource is supported in the form: projects/{project}/locations/{location}/lakes/{lake}/zones/{zone}/entities/{entity_id} Must belong in the same project and region as the attribute binding, and there can only exist one active binding for a resource.", +"description": "Required. Immutable. Full resource name of the cloud resource represented by the data asset. This must follow https://cloud.google.com/iam/docs/full-resource-names. Example: //bigquery.googleapis.com/projects/my_project_123/datasets/dataset_456/tables/table_789 Only BigQuery tables and datasets are currently supported. Data asset creator must have getIamPolicy and setIamPolicy permissions on the resource. Data asset creator must also have resource specific get permission, for instance, bigquery.tables.get for BigQuery tables.", "type": "string" }, "uid": { -"description": "Output only. System generated globally unique ID for the DataAttributeBinding. This ID will be different if the DataAttributeBinding is deleted and re-created with the same name.", +"description": "Output only. System generated globally unique ID for the data asset. This ID will be different if the data asset is deleted and re-created with the same name.", "readOnly": true, "type": "string" }, "updateTime": { -"description": "Output only. The time when the DataAttributeBinding was last updated.", +"description": "Output only. The time at which the data asset was last updated.", "format": "google-datetime", "readOnly": true, "type": "string" @@ -9523,19 +8893,34 @@ }, "type": "object" }, -"GoogleCloudDataplexV1DataAttributeBindingPath": { -"description": "Represents a subresource of the given resource, and associated bindings with it. Currently supported subresources are column and partition schema fields within a table.", -"id": "GoogleCloudDataplexV1DataAttributeBindingPath", +"GoogleCloudDataplexV1DataAssetAccessGroupConfig": { +"description": "Configuration for access group inherited from the parent data product.", +"id": "GoogleCloudDataplexV1DataAssetAccessGroupConfig", "properties": { -"attributes": { -"description": "Optional. List of attributes to be associated with the path of the resource, provided in the form: projects/{project}/locations/{location}/dataTaxonomies/{dataTaxonomy}/attributes/{data_attribute_id}", +"iamRoles": { +"description": "Optional. IAM roles granted on the resource to this access group. Role name follows https://cloud.google.com/iam/docs/reference/rest/v1/roles.Example: [ \"roles/bigquery.dataViewer\" ]", "items": { "type": "string" }, "type": "array" }, -"name": { -"description": "Required. The name identifier of the path. Nested columns should be of the form: 'address.city'.", +"state": { +"description": "Output only. The state of the iam role application.", +"enum": [ +"STATE_UNSPECIFIED", +"APPLYING", +"APPLIED", +"FAILED", +"UNSUPPORTED" +], +"enumDescriptions": [ +"State is unspecified.", +"The iam role is being applied.", +"The iam role has been successfully applied.", +"The iam role application failed due to transient error.", +"The iam role application is not supported for the asset resource type." +], +"readOnly": true, "type": "string" } }, @@ -10205,6 +9590,10 @@ "description": "Custom user defined access groups at the data product level. These are used for granting different levels of access (IAM roles) on the individual data product's data assets.", "id": "GoogleCloudDataplexV1DataProductAccessGroup", "properties": { +"defaultIamRoleConfig": { +"$ref": "GoogleCloudDataplexV1DataProductAccessGroupDefaultIamRoleConfig", +"description": "Optional. Default IAM role configuration to be applied on the data assets associated with this data product, for this access group." +}, "description": { "description": "Optional. Description of the access group.", "type": "string" @@ -10224,6 +9613,17 @@ }, "type": "object" }, +"GoogleCloudDataplexV1DataProductAccessGroupDefaultIamRoleConfig": { +"description": "Default IAM role configuration for an access group.", +"id": "GoogleCloudDataplexV1DataProductAccessGroupDefaultIamRoleConfig", +"properties": { +"role": { +"description": "Optional. The IAM role resource name to be applied as default. Example: \"roles/bigquery.dataViewer\".", +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDataplexV1DataProductAccessRequest": { "description": "Message for requesting access to a Data Product. This will be used to create a ChangeRequest of type REQUEST_DATA_PRODUCT_ACCESS.", "id": "GoogleCloudDataplexV1DataProductAccessRequest", @@ -12271,67 +11671,6 @@ }, "type": "object" }, -"GoogleCloudDataplexV1DataTaxonomy": { -"deprecated": true, -"description": "DataTaxonomy represents a set of hierarchical DataAttributes resources, grouped with a common theme Eg: 'SensitiveDataTaxonomy' can have attributes to manage PII data. It is defined at project level.", -"id": "GoogleCloudDataplexV1DataTaxonomy", -"properties": { -"attributeCount": { -"description": "Output only. The number of attributes in the DataTaxonomy.", -"format": "int32", -"readOnly": true, -"type": "integer" -}, -"classCount": { -"description": "Output only. The number of classes in the DataTaxonomy.", -"format": "int32", -"readOnly": true, -"type": "integer" -}, -"createTime": { -"description": "Output only. The time when the DataTaxonomy was created.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -}, -"description": { -"description": "Optional. Description of the DataTaxonomy.", -"type": "string" -}, -"displayName": { -"description": "Optional. User friendly display name.", -"type": "string" -}, -"etag": { -"description": "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.", -"type": "string" -}, -"labels": { -"additionalProperties": { -"type": "string" -}, -"description": "Optional. User-defined labels for the DataTaxonomy.", -"type": "object" -}, -"name": { -"description": "Output only. The relative resource name of the DataTaxonomy, of the form: projects/{project_number}/locations/{location_id}/dataTaxonomies/{data_taxonomy_id}.", -"readOnly": true, -"type": "string" -}, -"uid": { -"description": "Output only. System generated globally unique ID for the dataTaxonomy. This ID will be different if the DataTaxonomy is deleted and re-created with the same name.", -"readOnly": true, -"type": "string" -}, -"updateTime": { -"description": "Output only. The time when the DataTaxonomy was last updated.", -"format": "google-datetime", -"readOnly": true, -"type": "string" -} -}, -"type": "object" -}, "GoogleCloudDataplexV1DeleteEntryLinkRequest": { "description": "Request message for DeleteEntryLink.", "id": "GoogleCloudDataplexV1DeleteEntryLinkRequest", @@ -14264,56 +13603,6 @@ }, "type": "object" }, -"GoogleCloudDataplexV1ListDataAttributeBindingsResponse": { -"description": "List DataAttributeBindings response.", -"id": "GoogleCloudDataplexV1ListDataAttributeBindingsResponse", -"properties": { -"dataAttributeBindings": { -"description": "DataAttributeBindings under the given parent Location.", -"items": { -"$ref": "GoogleCloudDataplexV1DataAttributeBinding" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -}, -"unreachableLocations": { -"description": "Locations that could not be reached.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, -"GoogleCloudDataplexV1ListDataAttributesResponse": { -"description": "List DataAttributes response.", -"id": "GoogleCloudDataplexV1ListDataAttributesResponse", -"properties": { -"dataAttributes": { -"description": "DataAttributes under the given parent DataTaxonomy.", -"items": { -"$ref": "GoogleCloudDataplexV1DataAttribute" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -}, -"unreachableLocations": { -"description": "Locations that could not be reached.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDataplexV1ListDataDomainBindingsResponse": { "description": "List DataDomainBindings response.", "id": "GoogleCloudDataplexV1ListDataDomainBindingsResponse", @@ -14418,31 +13707,6 @@ }, "type": "object" }, -"GoogleCloudDataplexV1ListDataTaxonomiesResponse": { -"description": "List DataTaxonomies response.", -"id": "GoogleCloudDataplexV1ListDataTaxonomiesResponse", -"properties": { -"dataTaxonomies": { -"description": "DataTaxonomies under the given parent location.", -"items": { -"$ref": "GoogleCloudDataplexV1DataTaxonomy" -}, -"type": "array" -}, -"nextPageToken": { -"description": "Token to retrieve the next page of results, or empty if there are no more results in the list.", -"type": "string" -}, -"unreachableLocations": { -"description": "Locations that could not be reached.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDataplexV1ListEncryptionConfigsResponse": { "description": "List EncryptionConfigs Response", "id": "GoogleCloudDataplexV1ListEncryptionConfigsResponse", @@ -15455,34 +14719,6 @@ }, "type": "object" }, -"GoogleCloudDataplexV1ResourceAccessSpec": { -"description": "ResourceAccessSpec holds the access control configuration to be enforced on the resources, for example, Cloud Storage bucket, BigQuery dataset, BigQuery table.", -"id": "GoogleCloudDataplexV1ResourceAccessSpec", -"properties": { -"owners": { -"description": "Optional. The set of principals to be granted owner role on the resource.", -"items": { -"type": "string" -}, -"type": "array" -}, -"readers": { -"description": "Optional. The format of strings follows the pattern followed by IAM in the bindings. user:{email}, serviceAccount:{email} group:{email}. The set of principals to be granted reader role on the resource.", -"items": { -"type": "string" -}, -"type": "array" -}, -"writers": { -"description": "Optional. The set of principals to be granted writer role on the resource.", -"items": { -"type": "string" -}, -"type": "array" -} -}, -"type": "object" -}, "GoogleCloudDataplexV1RunDataScanRequest": { "description": "Run DataScan Request", "id": "GoogleCloudDataplexV1RunDataScanRequest", From 67a834cd356f25ba76ef50fe4974798469228bbf Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:36 +0000 Subject: [PATCH 16/41] feat(dataproc): update the api #### dataproc:v1 The following keys were added: - schemas.ApplicationAttemptInfo.properties.eventLogPath (Total Keys: 2) - schemas.GceClusterConfig.properties.multiZoneConfig.$ref (Total Keys: 1) - schemas.MultiZoneConfig (Total Keys: 3) - schemas.VirtualClusterOperationMetadata (Total Keys: 20) The following keys were changed: - endpoints (Total Keys: 1) --- ...s.locations.batches.sparkApplications.html | 4 + ...taproc_v1.projects.locations.sessions.html | 6 +- ....locations.sessions.sparkApplications.html | 4 + ....projects.locations.workflowTemplates.html | 21 ++++ ...dataproc_v1.projects.regions.clusters.html | 12 ++ ...v1.projects.regions.workflowTemplates.html | 21 ++++ .../documents/dataproc.v1.json | 104 +++++++++++++++++- 7 files changed, 167 insertions(+), 5 deletions(-) diff --git a/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html b/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html index 2b3a88413b..732b64b753 100644 --- a/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html +++ b/docs/dyn/dataproc_v1.projects.locations.batches.sparkApplications.html @@ -203,6 +203,7 @@

Method Details

"completed": True or False, "durationMillis": "A String", "endTime": "A String", + "eventLogPath": "A String", # Output only. The event log path for the application attempt. "lastUpdated": "A String", "sparkUser": "A String", "startTime": "A String", @@ -1280,6 +1281,7 @@

Method Details

"completed": True or False, "durationMillis": "A String", "endTime": "A String", + "eventLogPath": "A String", # Output only. The event log path for the application attempt. "lastUpdated": "A String", "sparkUser": "A String", "startTime": "A String", @@ -3250,6 +3252,7 @@

Method Details

"completed": True or False, "durationMillis": "A String", "endTime": "A String", + "eventLogPath": "A String", # Output only. The event log path for the application attempt. "lastUpdated": "A String", "sparkUser": "A String", "startTime": "A String", @@ -3390,6 +3393,7 @@

Method Details

"completed": True or False, "durationMillis": "A String", "endTime": "A String", + "eventLogPath": "A String", # Output only. The event log path for the application attempt. "lastUpdated": "A String", "sparkUser": "A String", "startTime": "A String", diff --git a/docs/dyn/dataproc_v1.projects.locations.sessions.html b/docs/dyn/dataproc_v1.projects.locations.sessions.html index c54e0bfeb6..85605cbe70 100644 --- a/docs/dyn/dataproc_v1.projects.locations.sessions.html +++ b/docs/dyn/dataproc_v1.projects.locations.sessions.html @@ -212,7 +212,7 @@

Method Details

}, }, }, - "sessionTemplate": "A String", # Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session. + "sessionTemplate": "A String", # Optional. The session template used by the session.Resource names and short template IDs are valid. Examples: * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * [template_id]The template must be in the same project and Dataproc region as the session. "sparkConnectSession": { # Spark connect configuration for an interactive session. # Optional. Spark connect session config. }, "state": "A String", # Output only. A state of the session. @@ -407,7 +407,7 @@

Method Details

}, }, }, - "sessionTemplate": "A String", # Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session. + "sessionTemplate": "A String", # Optional. The session template used by the session.Resource names and short template IDs are valid. Examples: * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * [template_id]The template must be in the same project and Dataproc region as the session. "sparkConnectSession": { # Spark connect configuration for an interactive session. # Optional. Spark connect session config. }, "state": "A String", # Output only. A state of the session. @@ -542,7 +542,7 @@

Method Details

}, }, }, - "sessionTemplate": "A String", # Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session. + "sessionTemplate": "A String", # Optional. The session template used by the session.Resource names and short template IDs are valid. Examples: * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * [template_id]The template must be in the same project and Dataproc region as the session. "sparkConnectSession": { # Spark connect configuration for an interactive session. # Optional. Spark connect session config. }, "state": "A String", # Output only. A state of the session. diff --git a/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html b/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html index 27e2a6771b..6a80613ca7 100644 --- a/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html +++ b/docs/dyn/dataproc_v1.projects.locations.sessions.sparkApplications.html @@ -200,6 +200,7 @@

Method Details

"completed": True or False, "durationMillis": "A String", "endTime": "A String", + "eventLogPath": "A String", # Output only. The event log path for the application attempt. "lastUpdated": "A String", "sparkUser": "A String", "startTime": "A String", @@ -1253,6 +1254,7 @@

Method Details

"completed": True or False, "durationMillis": "A String", "endTime": "A String", + "eventLogPath": "A String", # Output only. The event log path for the application attempt. "lastUpdated": "A String", "sparkUser": "A String", "startTime": "A String", @@ -3227,6 +3229,7 @@

Method Details

"completed": True or False, "durationMillis": "A String", "endTime": "A String", + "eventLogPath": "A String", # Output only. The event log path for the application attempt. "lastUpdated": "A String", "sparkUser": "A String", "startTime": "A String", @@ -3368,6 +3371,7 @@

Method Details

"completed": True or False, "durationMillis": "A String", "endTime": "A String", + "eventLogPath": "A String", # Output only. The event log path for the application attempt. "lastUpdated": "A String", "sparkUser": "A String", "startTime": "A String", diff --git a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html index c92267f58e..fcf0fe3347 100644 --- a/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.locations.workflowTemplates.html @@ -545,6 +545,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -1379,6 +1382,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -2240,6 +2246,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -3165,6 +3174,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -4040,6 +4052,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -4983,6 +4998,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -5817,6 +5835,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 diff --git a/docs/dyn/dataproc_v1.projects.regions.clusters.html b/docs/dyn/dataproc_v1.projects.regions.clusters.html index 32a0571d07..6b7e32cee3 100644 --- a/docs/dyn/dataproc_v1.projects.regions.clusters.html +++ b/docs/dyn/dataproc_v1.projects.regions.clusters.html @@ -289,6 +289,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -1073,6 +1076,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -1818,6 +1824,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -2483,6 +2492,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 diff --git a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html index c279b7ee5f..f5e2a2d21c 100644 --- a/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html +++ b/docs/dyn/dataproc_v1.projects.regions.workflowTemplates.html @@ -545,6 +545,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -1379,6 +1382,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -2240,6 +2246,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -3165,6 +3174,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -4040,6 +4052,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -4983,6 +4998,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 @@ -5817,6 +5835,9 @@

Method Details

"metadata": { # Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)). "a_key": "A String", }, + "multiZoneConfig": { # Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region. # Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set. + "targetShape": "A String", # Optional. The distribution shape of the nodes in the multi-zonal cluster. + }, "networkUri": "A String", # Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the "default" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default "nodeGroupAffinity": { # Node Group Affinity for clusters using sole-tenant node groups. The NodeGroupAffinity resource is not related to the NodeGroup resource. # Optional. Node Group Affinity for sole-tenant clusters. "nodeGroupUri": "A String", # Required. The URI of a sole-tenant node group resource (https://cloud.google.com/compute/docs/reference/rest/v1/nodeGroups) that the cluster will be created on.A full URL, partial URI, or node group name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 projects/[project_id]/zones/[zone]/nodeGroups/node-group-1 node-group-1 diff --git a/googleapiclient/discovery_cache/documents/dataproc.v1.json b/googleapiclient/discovery_cache/documents/dataproc.v1.json index 01f12dbec6..309a0542d3 100644 --- a/googleapiclient/discovery_cache/documents/dataproc.v1.json +++ b/googleapiclient/discovery_cache/documents/dataproc.v1.json @@ -29,6 +29,11 @@ }, { "description": "Regional Endpoint", +"endpointUrl": "https://dataproc.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://dataproc.europe-west9.rep.googleapis.com/", "location": "europe-west9" }, @@ -5498,7 +5503,7 @@ } } }, -"revision": "20260820", +"revision": "20260926", "rootUrl": "https://dataproc.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -5854,6 +5859,11 @@ "format": "google-datetime", "type": "string" }, +"eventLogPath": { +"description": "Output only. The event log path for the application attempt.", +"readOnly": true, +"type": "string" +}, "lastUpdated": { "format": "google-datetime", "type": "string" @@ -7794,6 +7804,10 @@ "description": "Optional. The Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).", "type": "object" }, +"multiZoneConfig": { +"$ref": "MultiZoneConfig", +"description": "Optional. Controls how instances within this Cluster are allowed to exist in multiple Zones within the Region. Only one of zone_uri or multi_zone_config must be set." +}, "networkUri": { "description": "Optional. The Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a Custom Subnet Network (see Using Subnetworks (https://cloud.google.com/compute/docs/subnetworks) for more information).A full URL, partial URI, or short name are valid. Examples: https://www.googleapis.com/compute/v1/projects/[project_id]/global/networks/default projects/[project_id]/global/networks/default default", "type": "string" @@ -9383,6 +9397,25 @@ }, "type": "object" }, +"MultiZoneConfig": { +"description": "Configuration for multi-zonal clusters that can create instances across multiple Zones within the Region.", +"id": "MultiZoneConfig", +"properties": { +"targetShape": { +"description": "Optional. The distribution shape of the nodes in the multi-zonal cluster.", +"enum": [ +"TARGET_SHAPE_UNSPECIFIED", +"ANY" +], +"enumDescriptions": [ +"Target shape is unspecified. Setting this will cause error.", +"Instances may exist in any Zones within the Region." +], +"type": "string" +} +}, +"type": "object" +}, "NamespacedGkeDeploymentTarget": { "deprecated": true, "description": "Deprecated. Used only for the deprecated beta. A full, namespace-isolated deployment target for an existing GKE cluster.", @@ -11073,7 +11106,7 @@ "readOnly": true }, "sessionTemplate": { -"description": "Optional. The session template used by the session.Only resource names, including project ID and location, are valid.Example: * https://www.googleapis.com/compute/v1/projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id]The template must be in the same project and Dataproc region as the session.", +"description": "Optional. The session template used by the session.Resource names and short template IDs are valid. Examples: * projects/[project_id]/locations/[dataproc_region]/sessionTemplates/[template_id] * [template_id]The template must be in the same project and Dataproc region as the session.", "type": "string" }, "sparkConnectSession": { @@ -13742,6 +13775,73 @@ }, "type": "object" }, +"VirtualClusterOperationMetadata": { +"description": "Metadata describing the VirtualCluster operation.", +"id": "VirtualClusterOperationMetadata", +"properties": { +"createTime": { +"description": "Output only. The time when the operation was created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"description": "Output only. Short description of the operation.", +"readOnly": true, +"type": "string" +}, +"doneTime": { +"description": "Output only. The time when the operation finished.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"labels": { +"additionalProperties": { +"type": "string" +}, +"description": "Output only. Labels associated with the operation.", +"readOnly": true, +"type": "object" +}, +"operationType": { +"description": "Output only. The operation type.", +"enum": [ +"VIRTUAL_CLUSTER_OPERATION_TYPE_UNSPECIFIED", +"CREATE", +"UPDATE", +"DELETE" +], +"enumDescriptions": [ +"VirtualCluster operation type is unknown.", +"Create VirtualCluster operation type.", +"Update VirtualCluster operation type.", +"Delete VirtualCluster operation type." +], +"readOnly": true, +"type": "string" +}, +"virtualCluster": { +"description": "Output only. Name of the virtual cluster for the operation.", +"readOnly": true, +"type": "string" +}, +"virtualClusterUuid": { +"description": "Output only. VirtualCluster UUID for the operation.", +"readOnly": true, +"type": "string" +}, +"warnings": { +"description": "Output only. Warnings encountered during operation execution.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +} +}, +"type": "object" +}, "WorkflowGraph": { "description": "The workflow graph.", "id": "WorkflowGraph", From dd430129fb430c1915a8e5090d53e0aac2a4d01d Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:37 +0000 Subject: [PATCH 17/41] feat(datastream): update the api #### datastream:v1 The following keys were added: - schemas.SqlServerChangeTables.properties.ddlConfig.$ref (Total Keys: 1) - schemas.SqlServerDdlConfig (Total Keys: 4) --- ...astream_v1.projects.locations.streams.html | 16 +++++++++++++ .../documents/datastream.v1.json | 24 +++++++++++++++++-- 2 files changed, 38 insertions(+), 2 deletions(-) diff --git a/docs/dyn/datastream_v1.projects.locations.streams.html b/docs/dyn/datastream_v1.projects.locations.streams.html index 33586c3f9a..6e58ff376c 100644 --- a/docs/dyn/datastream_v1.projects.locations.streams.html +++ b/docs/dyn/datastream_v1.projects.locations.streams.html @@ -814,6 +814,10 @@

Method Details

}, "sqlServerSourceConfig": { # Configuration for syncing data from a SQLServer source. # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. + "ddlConfig": { # DDL configuration for change tables. # Optional. DDL configuration for change tables. + "autoCreateNewCaptureInstanceOnDdl": True or False, # Optional. If set to true, Datastream will automatically create a new capture instance when DDL is detected on a table.The customer will be responsible for deleting it so that the next set of DDLs can be handled. The default is false and it means that DDL's will not be handled . + "autoDeleteOldCaptureInstance": True or False, # Optional. If set to true, Datastream will automatically delete the old capture instance after creating a new one to support a DDL change. The default is false and means that the customer has to delete the old capture instance manually. + }, }, "excludeObjects": { # SQLServer database structure. # The SQLServer objects to exclude from the stream. "schemas": [ # SQLServer schemas in the database server. @@ -1687,6 +1691,10 @@

Method Details

}, "sqlServerSourceConfig": { # Configuration for syncing data from a SQLServer source. # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. + "ddlConfig": { # DDL configuration for change tables. # Optional. DDL configuration for change tables. + "autoCreateNewCaptureInstanceOnDdl": True or False, # Optional. If set to true, Datastream will automatically create a new capture instance when DDL is detected on a table.The customer will be responsible for deleting it so that the next set of DDLs can be handled. The default is false and it means that DDL's will not be handled . + "autoDeleteOldCaptureInstance": True or False, # Optional. If set to true, Datastream will automatically delete the old capture instance after creating a new one to support a DDL change. The default is false and means that the customer has to delete the old capture instance manually. + }, }, "excludeObjects": { # SQLServer database structure. # The SQLServer objects to exclude from the stream. "schemas": [ # SQLServer schemas in the database server. @@ -2499,6 +2507,10 @@

Method Details

}, "sqlServerSourceConfig": { # Configuration for syncing data from a SQLServer source. # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. + "ddlConfig": { # DDL configuration for change tables. # Optional. DDL configuration for change tables. + "autoCreateNewCaptureInstanceOnDdl": True or False, # Optional. If set to true, Datastream will automatically create a new capture instance when DDL is detected on a table.The customer will be responsible for deleting it so that the next set of DDLs can be handled. The default is false and it means that DDL's will not be handled . + "autoDeleteOldCaptureInstance": True or False, # Optional. If set to true, Datastream will automatically delete the old capture instance after creating a new one to support a DDL change. The default is false and means that the customer has to delete the old capture instance manually. + }, }, "excludeObjects": { # SQLServer database structure. # The SQLServer objects to exclude from the stream. "schemas": [ # SQLServer schemas in the database server. @@ -3318,6 +3330,10 @@

Method Details

}, "sqlServerSourceConfig": { # Configuration for syncing data from a SQLServer source. # SQLServer data source configuration. "changeTables": { # Configuration to use Change Tables CDC read method. # CDC reader reads from change tables. + "ddlConfig": { # DDL configuration for change tables. # Optional. DDL configuration for change tables. + "autoCreateNewCaptureInstanceOnDdl": True or False, # Optional. If set to true, Datastream will automatically create a new capture instance when DDL is detected on a table.The customer will be responsible for deleting it so that the next set of DDLs can be handled. The default is false and it means that DDL's will not be handled . + "autoDeleteOldCaptureInstance": True or False, # Optional. If set to true, Datastream will automatically delete the old capture instance after creating a new one to support a DDL change. The default is false and means that the customer has to delete the old capture instance manually. + }, }, "excludeObjects": { # SQLServer database structure. # The SQLServer objects to exclude from the stream. "schemas": [ # SQLServer schemas in the database server. diff --git a/googleapiclient/discovery_cache/documents/datastream.v1.json b/googleapiclient/discovery_cache/documents/datastream.v1.json index 33683f588b..4e684ba3a8 100644 --- a/googleapiclient/discovery_cache/documents/datastream.v1.json +++ b/googleapiclient/discovery_cache/documents/datastream.v1.json @@ -1493,7 +1493,7 @@ } } }, -"revision": "20260719", +"revision": "20260923", "rootUrl": "https://datastream.googleapis.com/", "schemas": { "AppendOnly": { @@ -4714,7 +4714,12 @@ "SqlServerChangeTables": { "description": "Configuration to use Change Tables CDC read method.", "id": "SqlServerChangeTables", -"properties": {}, +"properties": { +"ddlConfig": { +"$ref": "SqlServerDdlConfig", +"description": "Optional. DDL configuration for change tables." +} +}, "type": "object" }, "SqlServerColumn": { @@ -4760,6 +4765,21 @@ }, "type": "object" }, +"SqlServerDdlConfig": { +"description": "DDL configuration for change tables.", +"id": "SqlServerDdlConfig", +"properties": { +"autoCreateNewCaptureInstanceOnDdl": { +"description": "Optional. If set to true, Datastream will automatically create a new capture instance when DDL is detected on a table.The customer will be responsible for deleting it so that the next set of DDLs can be handled. The default is false and it means that DDL's will not be handled .", +"type": "boolean" +}, +"autoDeleteOldCaptureInstance": { +"description": "Optional. If set to true, Datastream will automatically delete the old capture instance after creating a new one to support a DDL change. The default is false and means that the customer has to delete the old capture instance manually.", +"type": "boolean" +} +}, +"type": "object" +}, "SqlServerLsnPosition": { "description": "SQL Server LSN position", "id": "SqlServerLsnPosition", From ea914706061649bc17b704b3582c421936588aec Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:37 +0000 Subject: [PATCH 18/41] feat(dialogflow): update the api #### dialogflow:v2 The following keys were added: - resources.projects.resources.locations.resources.companionAgents.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.companionAgents.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.companionAgents.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.companionAgents.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.companionAgents.methods.patch (Total Keys: 15) - schemas.GoogleCloudDialogflowV2AgentAssistantFeedback.properties.companionFeedback.$ref (Total Keys: 1) - schemas.GoogleCloudDialogflowV2AgentAssistantFeedbackCompanionFeedback (Total Keys: 2) - schemas.GoogleCloudDialogflowV2AgentAssistantRecord.properties.companionSuggestion (Total Keys: 2) - schemas.GoogleCloudDialogflowV2AgentAssistantRecord.properties.reactiveCompanionSuggestion (Total Keys: 2) - schemas.GoogleCloudDialogflowV2CompanionAgent (Total Keys: 33) - schemas.GoogleCloudDialogflowV2CompanionSuggestion (Total Keys: 20) - schemas.GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse (Total Keys: 8) - schemas.GoogleCloudDialogflowV2GroundingChunk (Total Keys: 16) - schemas.GoogleCloudDialogflowV2GroundingMetadata (Total Keys: 9) - schemas.GoogleCloudDialogflowV2GroundingSupport (Total Keys: 6) - schemas.GoogleCloudDialogflowV2GuidanceInstruction (Total Keys: 11) - schemas.GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig.properties.companionAgent.type (Total Keys: 1) - schemas.GoogleCloudDialogflowV2ListCompanionAgentsResponse (Total Keys: 5) - schemas.GoogleCloudDialogflowV2SearchEntryPoint (Total Keys: 3) - schemas.GoogleCloudDialogflowV2Segment (Total Keys: 10) - schemas.GoogleCloudDialogflowV2StreamingReactiveCompanionSuggestionsResponseReactiveModeResponse (Total Keys: 6) - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateCompanionSuggestionsResponse.$ref (Total Keys: 1) - schemas.GoogleCloudDialogflowV2ToolCallSuggestion (Total Keys: 4) - schemas.GoogleCloudDialogflowV2beta1CompanionSuggestion (Total Keys: 20) - schemas.GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse (Total Keys: 8) - schemas.GoogleCloudDialogflowV2beta1GroundingChunk (Total Keys: 16) - schemas.GoogleCloudDialogflowV2beta1GroundingMetadata (Total Keys: 9) - schemas.GoogleCloudDialogflowV2beta1GroundingSupport (Total Keys: 6) - schemas.GoogleCloudDialogflowV2beta1GuidanceInstruction (Total Keys: 11) - schemas.GoogleCloudDialogflowV2beta1SearchEntryPoint (Total Keys: 3) - schemas.GoogleCloudDialogflowV2beta1Segment (Total Keys: 10) - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateCompanionSuggestionsResponse.$ref (Total Keys: 1) - schemas.GoogleCloudDialogflowV2beta1ToolCallSuggestion (Total Keys: 4) #### dialogflow:v2beta1 The following keys were added: - resources.projects.resources.locations.resources.companionAgents.methods.create (Total Keys: 14) - resources.projects.resources.locations.resources.companionAgents.methods.delete (Total Keys: 11) - resources.projects.resources.locations.resources.companionAgents.methods.get (Total Keys: 11) - resources.projects.resources.locations.resources.companionAgents.methods.list (Total Keys: 16) - resources.projects.resources.locations.resources.companionAgents.methods.patch (Total Keys: 15) - schemas.GoogleCloudDialogflowV2CompanionSuggestion (Total Keys: 20) - schemas.GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse (Total Keys: 8) - schemas.GoogleCloudDialogflowV2GroundingChunk (Total Keys: 16) - schemas.GoogleCloudDialogflowV2GroundingMetadata (Total Keys: 9) - schemas.GoogleCloudDialogflowV2GroundingSupport (Total Keys: 6) - schemas.GoogleCloudDialogflowV2GuidanceInstruction (Total Keys: 11) - schemas.GoogleCloudDialogflowV2SearchEntryPoint (Total Keys: 3) - schemas.GoogleCloudDialogflowV2Segment (Total Keys: 10) - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateCompanionSuggestionsResponse.$ref (Total Keys: 1) - schemas.GoogleCloudDialogflowV2ToolCallSuggestion (Total Keys: 4) - schemas.GoogleCloudDialogflowV2beta1AgentAssistantFeedback.properties.companionFeedback.$ref (Total Keys: 1) - schemas.GoogleCloudDialogflowV2beta1AgentAssistantFeedbackCompanionFeedback (Total Keys: 2) - schemas.GoogleCloudDialogflowV2beta1AgentAssistantRecord.properties.companionSuggestion (Total Keys: 2) - schemas.GoogleCloudDialogflowV2beta1AgentAssistantRecord.properties.reactiveCompanionSuggestion (Total Keys: 2) - schemas.GoogleCloudDialogflowV2beta1CompanionAgent (Total Keys: 28) - schemas.GoogleCloudDialogflowV2beta1CompanionSuggestion (Total Keys: 20) - schemas.GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse (Total Keys: 8) - schemas.GoogleCloudDialogflowV2beta1GroundingChunk (Total Keys: 16) - schemas.GoogleCloudDialogflowV2beta1GroundingMetadata (Total Keys: 9) - schemas.GoogleCloudDialogflowV2beta1GroundingSupport (Total Keys: 6) - schemas.GoogleCloudDialogflowV2beta1GuidanceInstruction (Total Keys: 11) - schemas.GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionConfig.properties.companionAgent.type (Total Keys: 1) - schemas.GoogleCloudDialogflowV2beta1ListCompanionAgentsResponse (Total Keys: 5) - schemas.GoogleCloudDialogflowV2beta1SearchEntryPoint (Total Keys: 3) - schemas.GoogleCloudDialogflowV2beta1Segment (Total Keys: 10) - schemas.GoogleCloudDialogflowV2beta1StreamingReactiveCompanionSuggestionsResponseReactiveModeResponse (Total Keys: 6) - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateCompanionSuggestionsResponse.$ref (Total Keys: 1) - schemas.GoogleCloudDialogflowV2beta1ToolCallSuggestion (Total Keys: 4) #### dialogflow:v3 The following keys were added: - schemas.GoogleCloudDialogflowV2CompanionSuggestion (Total Keys: 20) - schemas.GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse (Total Keys: 8) - schemas.GoogleCloudDialogflowV2GroundingChunk (Total Keys: 16) - schemas.GoogleCloudDialogflowV2GroundingMetadata (Total Keys: 9) - schemas.GoogleCloudDialogflowV2GroundingSupport (Total Keys: 6) - schemas.GoogleCloudDialogflowV2GuidanceInstruction (Total Keys: 11) - schemas.GoogleCloudDialogflowV2SearchEntryPoint (Total Keys: 3) - schemas.GoogleCloudDialogflowV2Segment (Total Keys: 10) - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateCompanionSuggestionsResponse.$ref (Total Keys: 1) - schemas.GoogleCloudDialogflowV2ToolCallSuggestion (Total Keys: 4) - schemas.GoogleCloudDialogflowV2beta1CompanionSuggestion (Total Keys: 20) - schemas.GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse (Total Keys: 8) - schemas.GoogleCloudDialogflowV2beta1GroundingChunk (Total Keys: 16) - schemas.GoogleCloudDialogflowV2beta1GroundingMetadata (Total Keys: 9) - schemas.GoogleCloudDialogflowV2beta1GroundingSupport (Total Keys: 6) - schemas.GoogleCloudDialogflowV2beta1GuidanceInstruction (Total Keys: 11) - schemas.GoogleCloudDialogflowV2beta1SearchEntryPoint (Total Keys: 3) - schemas.GoogleCloudDialogflowV2beta1Segment (Total Keys: 10) - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateCompanionSuggestionsResponse.$ref (Total Keys: 1) - schemas.GoogleCloudDialogflowV2beta1ToolCallSuggestion (Total Keys: 4) #### dialogflow:v3beta1 The following keys were added: - schemas.GoogleCloudDialogflowV2CompanionSuggestion (Total Keys: 20) - schemas.GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse (Total Keys: 8) - schemas.GoogleCloudDialogflowV2GroundingChunk (Total Keys: 16) - schemas.GoogleCloudDialogflowV2GroundingMetadata (Total Keys: 9) - schemas.GoogleCloudDialogflowV2GroundingSupport (Total Keys: 6) - schemas.GoogleCloudDialogflowV2GuidanceInstruction (Total Keys: 11) - schemas.GoogleCloudDialogflowV2SearchEntryPoint (Total Keys: 3) - schemas.GoogleCloudDialogflowV2Segment (Total Keys: 10) - schemas.GoogleCloudDialogflowV2SuggestionResult.properties.generateCompanionSuggestionsResponse.$ref (Total Keys: 1) - schemas.GoogleCloudDialogflowV2ToolCallSuggestion (Total Keys: 4) - schemas.GoogleCloudDialogflowV2beta1CompanionSuggestion (Total Keys: 20) - schemas.GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse (Total Keys: 8) - schemas.GoogleCloudDialogflowV2beta1GroundingChunk (Total Keys: 16) - schemas.GoogleCloudDialogflowV2beta1GroundingMetadata (Total Keys: 9) - schemas.GoogleCloudDialogflowV2beta1GroundingSupport (Total Keys: 6) - schemas.GoogleCloudDialogflowV2beta1GuidanceInstruction (Total Keys: 11) - schemas.GoogleCloudDialogflowV2beta1SearchEntryPoint (Total Keys: 3) - schemas.GoogleCloudDialogflowV2beta1Segment (Total Keys: 10) - schemas.GoogleCloudDialogflowV2beta1SuggestionResult.properties.generateCompanionSuggestionsResponse.$ref (Total Keys: 1) - schemas.GoogleCloudDialogflowV2beta1ToolCallSuggestion (Total Keys: 4) --- .../dialogflow_v2.projects.answerRecords.html | 534 ++++++++++ ...flow_v2.projects.conversationProfiles.html | 12 + .../dialogflow_v2.projects.conversations.html | 10 + ...2.projects.conversations.participants.html | 214 ++++ ...w_v2.projects.locations.answerRecords.html | 534 ++++++++++ ...v2.projects.locations.companionAgents.html | 505 ++++++++++ ...ojects.locations.conversationProfiles.html | 12 + ...w_v2.projects.locations.conversations.html | 10 + ....locations.conversations.participants.html | 214 ++++ .../dyn/dialogflow_v2.projects.locations.html | 5 + ...low_v2.projects.locations.suggestions.html | 2 + .../dialogflow_v2.projects.suggestions.html | 2 + ...ogflow_v2beta1.projects.answerRecords.html | 712 ++++++++++++++ ...v2beta1.projects.conversationProfiles.html | 12 + ...ogflow_v2beta1.projects.conversations.html | 10 + ...1.projects.conversations.participants.html | 214 ++++ ...eta1.projects.locations.answerRecords.html | 712 ++++++++++++++ ...a1.projects.locations.companionAgents.html | 481 +++++++++ ...ojects.locations.conversationProfiles.html | 12 + ...eta1.projects.locations.conversations.html | 10 + ....locations.conversations.participants.html | 214 ++++ ...dialogflow_v2beta1.projects.locations.html | 5 + ...2beta1.projects.locations.suggestions.html | 2 + ...alogflow_v2beta1.projects.suggestions.html | 2 + .../documents/dialogflow.v2.json | 850 +++++++++++++++- .../documents/dialogflow.v2beta1.json | 931 +++++++++++++++++- .../documents/dialogflow.v3.json | 540 +++++++++- .../documents/dialogflow.v3beta1.json | 540 +++++++++- 28 files changed, 7249 insertions(+), 52 deletions(-) create mode 100644 docs/dyn/dialogflow_v2.projects.locations.companionAgents.html create mode 100644 docs/dyn/dialogflow_v2beta1.projects.locations.companionAgents.html diff --git a/docs/dyn/dialogflow_v2.projects.answerRecords.html b/docs/dyn/dialogflow_v2.projects.answerRecords.html index ae76a07596..1734d8db9f 100644 --- a/docs/dyn/dialogflow_v2.projects.answerRecords.html +++ b/docs/dyn/dialogflow_v2.projects.answerRecords.html @@ -125,6 +125,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -715,10 +817,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { @@ -792,6 +970,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -1382,10 +1662,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { @@ -1441,6 +1797,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -2031,10 +2489,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { diff --git a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html index 8d4e2c10dd..fea3ccf2c7 100644 --- a/docs/dyn/dialogflow_v2.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.conversationProfiles.html @@ -168,6 +168,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -243,6 +244,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -427,6 +429,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -502,6 +505,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -711,6 +715,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -786,6 +791,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -981,6 +987,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1056,6 +1063,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1259,6 +1267,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1334,6 +1343,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1519,6 +1529,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1594,6 +1605,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/docs/dyn/dialogflow_v2.projects.conversations.html b/docs/dyn/dialogflow_v2.projects.conversations.html index a05b7ec0c2..31426a57b2 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.html @@ -161,6 +161,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -236,6 +237,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -470,6 +472,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -545,6 +548,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -778,6 +782,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -853,6 +858,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1092,6 +1098,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1167,6 +1174,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1411,6 +1419,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1486,6 +1495,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/docs/dyn/dialogflow_v2.projects.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.conversations.participants.html index b9c748c677..888968dd2d 100644 --- a/docs/dyn/dialogflow_v2.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.conversations.participants.html @@ -763,6 +763,113 @@

Method Details

], "message": "A String", }, + "generateCompanionSuggestionsResponse": { + "answerRecord": "A String", + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, + "latestMessage": "A String", + "suggestionIndex": 42, + }, "generateSuggestionsResponse": { "generatorSuggestionAnswers": [ { @@ -1077,6 +1184,113 @@

Method Details

], "message": "A String", }, + "generateCompanionSuggestionsResponse": { + "answerRecord": "A String", + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, + "latestMessage": "A String", + "suggestionIndex": 42, + }, "generateSuggestionsResponse": { "generatorSuggestionAnswers": [ { diff --git a/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html b/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html index 3772760af4..82ec86ece2 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html +++ b/docs/dyn/dialogflow_v2.projects.locations.answerRecords.html @@ -125,6 +125,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -715,10 +817,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { @@ -792,6 +970,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -1382,10 +1662,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { @@ -1441,6 +1797,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -2031,10 +2489,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { diff --git a/docs/dyn/dialogflow_v2.projects.locations.companionAgents.html b/docs/dyn/dialogflow_v2.projects.locations.companionAgents.html new file mode 100644 index 0000000000..eb815aac14 --- /dev/null +++ b/docs/dyn/dialogflow_v2.projects.locations.companionAgents.html @@ -0,0 +1,505 @@ + + + +

Dialogflow API . projects . locations . companionAgents

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

+

+ delete(name, x__xgafv=None)

+

+

+ get(name, x__xgafv=None)

+

+

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

+

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, companionAgentId=None, x__xgafv=None) +
+
+Args:
+  parent: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "cesToolSpecs": [
+    {
+      "cesTool": "A String",
+      "confirmationRequirement": "A String",
+    },
+  ],
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
+  "skillConfigs": [
+    {
+      "guidanceSkillConfig": {
+        "guidanceInstructions": [
+          {
+            "actions": [
+              {
+                "description": "A String",
+              },
+            ],
+            "condition": "A String",
+            "disableSuggestedReply": True or False,
+            "displayDetails": "A String",
+            "displayName": "A String",
+            "triggerEvent": "A String",
+          },
+        ],
+        "knowledgeSource": {
+        },
+        "overarchingGuidance": "A String",
+      },
+      "skillTriggeringEvent": "A String",
+      "translationSkillConfig": {
+        "agentLanguageCode": "A String",
+        "customerLanguageCode": "A String",
+      },
+    },
+  ],
+  "toolsetTools": [
+    {
+      "confirmationRequirement": "A String",
+      "operationId": "A String",
+      "toolset": "A String",
+    },
+  ],
+  "updateTime": "A String",
+}
+
+  companionAgentId: string, A parameter
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "cesToolSpecs": [
+    {
+      "cesTool": "A String",
+      "confirmationRequirement": "A String",
+    },
+  ],
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
+  "skillConfigs": [
+    {
+      "guidanceSkillConfig": {
+        "guidanceInstructions": [
+          {
+            "actions": [
+              {
+                "description": "A String",
+              },
+            ],
+            "condition": "A String",
+            "disableSuggestedReply": True or False,
+            "displayDetails": "A String",
+            "displayName": "A String",
+            "triggerEvent": "A String",
+          },
+        ],
+        "knowledgeSource": {
+        },
+        "overarchingGuidance": "A String",
+      },
+      "skillTriggeringEvent": "A String",
+      "translationSkillConfig": {
+        "agentLanguageCode": "A String",
+        "customerLanguageCode": "A String",
+      },
+    },
+  ],
+  "toolsetTools": [
+    {
+      "confirmationRequirement": "A String",
+      "operationId": "A String",
+      "toolset": "A String",
+    },
+  ],
+  "updateTime": "A String",
+}
+
+ +
+ delete(name, x__xgafv=None) +
+
+Args:
+  name: string, A parameter (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+}
+
+ +
+ get(name, x__xgafv=None) +
+
+Args:
+  name: string, A parameter (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "cesToolSpecs": [
+    {
+      "cesTool": "A String",
+      "confirmationRequirement": "A String",
+    },
+  ],
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
+  "skillConfigs": [
+    {
+      "guidanceSkillConfig": {
+        "guidanceInstructions": [
+          {
+            "actions": [
+              {
+                "description": "A String",
+              },
+            ],
+            "condition": "A String",
+            "disableSuggestedReply": True or False,
+            "displayDetails": "A String",
+            "displayName": "A String",
+            "triggerEvent": "A String",
+          },
+        ],
+        "knowledgeSource": {
+        },
+        "overarchingGuidance": "A String",
+      },
+      "skillTriggeringEvent": "A String",
+      "translationSkillConfig": {
+        "agentLanguageCode": "A String",
+        "customerLanguageCode": "A String",
+      },
+    },
+  ],
+  "toolsetTools": [
+    {
+      "confirmationRequirement": "A String",
+      "operationId": "A String",
+      "toolset": "A String",
+    },
+  ],
+  "updateTime": "A String",
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
+
+Args:
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "companionAgents": [
+    {
+      "cesToolSpecs": [
+        {
+          "cesTool": "A String",
+          "confirmationRequirement": "A String",
+        },
+      ],
+      "createTime": "A String",
+      "description": "A String",
+      "displayName": "A String",
+      "name": "A String",
+      "skillConfigs": [
+        {
+          "guidanceSkillConfig": {
+            "guidanceInstructions": [
+              {
+                "actions": [
+                  {
+                    "description": "A String",
+                  },
+                ],
+                "condition": "A String",
+                "disableSuggestedReply": True or False,
+                "displayDetails": "A String",
+                "displayName": "A String",
+                "triggerEvent": "A String",
+              },
+            ],
+            "knowledgeSource": {
+            },
+            "overarchingGuidance": "A String",
+          },
+          "skillTriggeringEvent": "A String",
+          "translationSkillConfig": {
+            "agentLanguageCode": "A String",
+            "customerLanguageCode": "A String",
+          },
+        },
+      ],
+      "toolsetTools": [
+        {
+          "confirmationRequirement": "A String",
+          "operationId": "A String",
+          "toolset": "A String",
+        },
+      ],
+      "updateTime": "A String",
+    },
+  ],
+  "nextPageToken": "A String",
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
+
+Args:
+  name: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "cesToolSpecs": [
+    {
+      "cesTool": "A String",
+      "confirmationRequirement": "A String",
+    },
+  ],
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
+  "skillConfigs": [
+    {
+      "guidanceSkillConfig": {
+        "guidanceInstructions": [
+          {
+            "actions": [
+              {
+                "description": "A String",
+              },
+            ],
+            "condition": "A String",
+            "disableSuggestedReply": True or False,
+            "displayDetails": "A String",
+            "displayName": "A String",
+            "triggerEvent": "A String",
+          },
+        ],
+        "knowledgeSource": {
+        },
+        "overarchingGuidance": "A String",
+      },
+      "skillTriggeringEvent": "A String",
+      "translationSkillConfig": {
+        "agentLanguageCode": "A String",
+        "customerLanguageCode": "A String",
+      },
+    },
+  ],
+  "toolsetTools": [
+    {
+      "confirmationRequirement": "A String",
+      "operationId": "A String",
+      "toolset": "A String",
+    },
+  ],
+  "updateTime": "A String",
+}
+
+  updateMask: string, A parameter
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "cesToolSpecs": [
+    {
+      "cesTool": "A String",
+      "confirmationRequirement": "A String",
+    },
+  ],
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
+  "skillConfigs": [
+    {
+      "guidanceSkillConfig": {
+        "guidanceInstructions": [
+          {
+            "actions": [
+              {
+                "description": "A String",
+              },
+            ],
+            "condition": "A String",
+            "disableSuggestedReply": True or False,
+            "displayDetails": "A String",
+            "displayName": "A String",
+            "triggerEvent": "A String",
+          },
+        ],
+        "knowledgeSource": {
+        },
+        "overarchingGuidance": "A String",
+      },
+      "skillTriggeringEvent": "A String",
+      "translationSkillConfig": {
+        "agentLanguageCode": "A String",
+        "customerLanguageCode": "A String",
+      },
+    },
+  ],
+  "toolsetTools": [
+    {
+      "confirmationRequirement": "A String",
+      "operationId": "A String",
+      "toolset": "A String",
+    },
+  ],
+  "updateTime": "A String",
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html index 74b3a98bbd..aa7a4c3600 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversationProfiles.html @@ -168,6 +168,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -243,6 +244,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -427,6 +429,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -502,6 +505,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -711,6 +715,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -786,6 +791,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -981,6 +987,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1056,6 +1063,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1259,6 +1267,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1334,6 +1343,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1519,6 +1529,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1594,6 +1605,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.html index e4e5794c83..fb35ed4358 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.html @@ -164,6 +164,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -239,6 +240,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -473,6 +475,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -548,6 +551,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -781,6 +785,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -856,6 +861,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1095,6 +1101,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1170,6 +1177,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1468,6 +1476,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1543,6 +1552,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html index cb1f284661..e327d2c1de 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2.projects.locations.conversations.participants.html @@ -763,6 +763,113 @@

Method Details

], "message": "A String", }, + "generateCompanionSuggestionsResponse": { + "answerRecord": "A String", + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, + "latestMessage": "A String", + "suggestionIndex": 42, + }, "generateSuggestionsResponse": { "generatorSuggestionAnswers": [ { @@ -1077,6 +1184,113 @@

Method Details

], "message": "A String", }, + "generateCompanionSuggestionsResponse": { + "answerRecord": "A String", + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, + "latestMessage": "A String", + "suggestionIndex": 42, + }, "generateSuggestionsResponse": { "generatorSuggestionAnswers": [ { diff --git a/docs/dyn/dialogflow_v2.projects.locations.html b/docs/dyn/dialogflow_v2.projects.locations.html index ddd3990907..82a131955c 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.html +++ b/docs/dyn/dialogflow_v2.projects.locations.html @@ -84,6 +84,11 @@

Instance Methods

Returns the answerRecords Resource.

+

+ companionAgents() +

+

Returns the companionAgents Resource.

+

conversationDatasets()

diff --git a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html index 472efc3139..2171f31e4d 100644 --- a/docs/dyn/dialogflow_v2.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.locations.suggestions.html @@ -108,6 +108,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -183,6 +184,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/docs/dyn/dialogflow_v2.projects.suggestions.html b/docs/dyn/dialogflow_v2.projects.suggestions.html index 43bc9bb15e..1737af8b1e 100644 --- a/docs/dyn/dialogflow_v2.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2.projects.suggestions.html @@ -108,6 +108,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -183,6 +184,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html b/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html index 7d63b5bac6..c376568c6c 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html +++ b/docs/dyn/dialogflow_v2beta1.projects.answerRecords.html @@ -122,6 +122,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -924,10 +1026,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { @@ -993,6 +1171,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -1795,10 +2075,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { @@ -1871,6 +2227,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -2673,10 +3131,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { @@ -2731,6 +3265,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -3533,10 +4169,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html index 3db80cf863..5a3a1b76d0 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversationProfiles.html @@ -168,6 +168,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -239,6 +240,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -420,6 +422,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -491,6 +494,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -697,6 +701,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -768,6 +773,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -960,6 +966,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1031,6 +1038,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1231,6 +1239,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1302,6 +1311,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1484,6 +1494,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1555,6 +1566,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.html index 1934606610..abad93b863 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.html @@ -161,6 +161,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -232,6 +233,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -463,6 +465,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -534,6 +537,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -764,6 +768,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -835,6 +840,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1071,6 +1077,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1142,6 +1149,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1383,6 +1391,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1454,6 +1463,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html index 4840c14b15..b524e0e111 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.conversations.participants.html @@ -1715,6 +1715,113 @@

Method Details

], "message": "A String", }, + "generateCompanionSuggestionsResponse": { + "answerRecord": "A String", + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, + "latestMessage": "A String", + "suggestionIndex": 42, + }, "generateSuggestionsResponse": { "generatorSuggestionAnswers": [ { @@ -3392,6 +3499,113 @@

Method Details

], "message": "A String", }, + "generateCompanionSuggestionsResponse": { + "answerRecord": "A String", + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, + "latestMessage": "A String", + "suggestionIndex": 42, + }, "generateSuggestionsResponse": { "generatorSuggestionAnswers": [ { diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html b/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html index 42bc3d6b66..da8352c201 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.answerRecords.html @@ -122,6 +122,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -924,10 +1026,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { @@ -993,6 +1171,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -1795,10 +2075,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { @@ -1871,6 +2227,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -2673,10 +3131,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { @@ -2731,6 +3265,108 @@

Method Details

"title": "A String", "uri": "A String", }, + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, "dialogflowAssistAnswer": { "answerRecord": "A String", "intentSuggestion": { @@ -3533,10 +4169,86 @@

Method Details

}, ], }, + "reactiveCompanionSuggestion": { + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "response": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + }, }, "answerFeedback": { "agentAssistantDetailFeedback": { "answerRelevance": "A String", + "companionFeedback": { + }, "documentCorrectness": "A String", "documentEfficiency": "A String", "knowledgeAssistFeedback": { diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.companionAgents.html b/docs/dyn/dialogflow_v2beta1.projects.locations.companionAgents.html new file mode 100644 index 0000000000..4222c35796 --- /dev/null +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.companionAgents.html @@ -0,0 +1,481 @@ + + + +

Dialogflow API . projects . locations . companionAgents

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

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

+

+

+ delete(name, x__xgafv=None)

+

+

+ get(name, x__xgafv=None)

+

+

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

+

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

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

+

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ create(parent, body=None, companionAgentId=None, x__xgafv=None) +
+
+Args:
+  parent: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "cesToolSpecs": [
+    {
+      "cesTool": "A String",
+      "confirmationRequirement": "A String",
+    },
+  ],
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
+  "skillConfigs": [
+    {
+      "guidanceSkillConfig": {
+        "guidanceInstructions": [
+          {
+            "actions": [
+              {
+                "description": "A String",
+              },
+            ],
+            "condition": "A String",
+            "disableSuggestedReply": True or False,
+            "displayDetails": "A String",
+            "displayName": "A String",
+            "triggerEvent": "A String",
+          },
+        ],
+        "knowledgeSource": {
+        },
+        "overarchingGuidance": "A String",
+      },
+      "skillTriggeringEvent": "A String",
+    },
+  ],
+  "toolsetTools": [
+    {
+      "confirmationRequirement": "A String",
+      "operationId": "A String",
+      "toolset": "A String",
+    },
+  ],
+  "updateTime": "A String",
+}
+
+  companionAgentId: string, A parameter
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "cesToolSpecs": [
+    {
+      "cesTool": "A String",
+      "confirmationRequirement": "A String",
+    },
+  ],
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
+  "skillConfigs": [
+    {
+      "guidanceSkillConfig": {
+        "guidanceInstructions": [
+          {
+            "actions": [
+              {
+                "description": "A String",
+              },
+            ],
+            "condition": "A String",
+            "disableSuggestedReply": True or False,
+            "displayDetails": "A String",
+            "displayName": "A String",
+            "triggerEvent": "A String",
+          },
+        ],
+        "knowledgeSource": {
+        },
+        "overarchingGuidance": "A String",
+      },
+      "skillTriggeringEvent": "A String",
+    },
+  ],
+  "toolsetTools": [
+    {
+      "confirmationRequirement": "A String",
+      "operationId": "A String",
+      "toolset": "A String",
+    },
+  ],
+  "updateTime": "A String",
+}
+
+ +
+ delete(name, x__xgafv=None) +
+
+Args:
+  name: string, A parameter (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+}
+
+ +
+ get(name, x__xgafv=None) +
+
+Args:
+  name: string, A parameter (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "cesToolSpecs": [
+    {
+      "cesTool": "A String",
+      "confirmationRequirement": "A String",
+    },
+  ],
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
+  "skillConfigs": [
+    {
+      "guidanceSkillConfig": {
+        "guidanceInstructions": [
+          {
+            "actions": [
+              {
+                "description": "A String",
+              },
+            ],
+            "condition": "A String",
+            "disableSuggestedReply": True or False,
+            "displayDetails": "A String",
+            "displayName": "A String",
+            "triggerEvent": "A String",
+          },
+        ],
+        "knowledgeSource": {
+        },
+        "overarchingGuidance": "A String",
+      },
+      "skillTriggeringEvent": "A String",
+    },
+  ],
+  "toolsetTools": [
+    {
+      "confirmationRequirement": "A String",
+      "operationId": "A String",
+      "toolset": "A String",
+    },
+  ],
+  "updateTime": "A String",
+}
+
+ +
+ list(parent, pageSize=None, pageToken=None, x__xgafv=None) +
+
+Args:
+  parent: string, A parameter (required)
+  pageSize: integer, A parameter
+  pageToken: string, A parameter
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "companionAgents": [
+    {
+      "cesToolSpecs": [
+        {
+          "cesTool": "A String",
+          "confirmationRequirement": "A String",
+        },
+      ],
+      "createTime": "A String",
+      "description": "A String",
+      "displayName": "A String",
+      "name": "A String",
+      "skillConfigs": [
+        {
+          "guidanceSkillConfig": {
+            "guidanceInstructions": [
+              {
+                "actions": [
+                  {
+                    "description": "A String",
+                  },
+                ],
+                "condition": "A String",
+                "disableSuggestedReply": True or False,
+                "displayDetails": "A String",
+                "displayName": "A String",
+                "triggerEvent": "A String",
+              },
+            ],
+            "knowledgeSource": {
+            },
+            "overarchingGuidance": "A String",
+          },
+          "skillTriggeringEvent": "A String",
+        },
+      ],
+      "toolsetTools": [
+        {
+          "confirmationRequirement": "A String",
+          "operationId": "A String",
+          "toolset": "A String",
+        },
+      ],
+      "updateTime": "A String",
+    },
+  ],
+  "nextPageToken": "A String",
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ patch(name, body=None, updateMask=None, x__xgafv=None) +
+
+Args:
+  name: string, A parameter (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{
+  "cesToolSpecs": [
+    {
+      "cesTool": "A String",
+      "confirmationRequirement": "A String",
+    },
+  ],
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
+  "skillConfigs": [
+    {
+      "guidanceSkillConfig": {
+        "guidanceInstructions": [
+          {
+            "actions": [
+              {
+                "description": "A String",
+              },
+            ],
+            "condition": "A String",
+            "disableSuggestedReply": True or False,
+            "displayDetails": "A String",
+            "displayName": "A String",
+            "triggerEvent": "A String",
+          },
+        ],
+        "knowledgeSource": {
+        },
+        "overarchingGuidance": "A String",
+      },
+      "skillTriggeringEvent": "A String",
+    },
+  ],
+  "toolsetTools": [
+    {
+      "confirmationRequirement": "A String",
+      "operationId": "A String",
+      "toolset": "A String",
+    },
+  ],
+  "updateTime": "A String",
+}
+
+  updateMask: string, A parameter
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    {
+  "cesToolSpecs": [
+    {
+      "cesTool": "A String",
+      "confirmationRequirement": "A String",
+    },
+  ],
+  "createTime": "A String",
+  "description": "A String",
+  "displayName": "A String",
+  "name": "A String",
+  "skillConfigs": [
+    {
+      "guidanceSkillConfig": {
+        "guidanceInstructions": [
+          {
+            "actions": [
+              {
+                "description": "A String",
+              },
+            ],
+            "condition": "A String",
+            "disableSuggestedReply": True or False,
+            "displayDetails": "A String",
+            "displayName": "A String",
+            "triggerEvent": "A String",
+          },
+        ],
+        "knowledgeSource": {
+        },
+        "overarchingGuidance": "A String",
+      },
+      "skillTriggeringEvent": "A String",
+    },
+  ],
+  "toolsetTools": [
+    {
+      "confirmationRequirement": "A String",
+      "operationId": "A String",
+      "toolset": "A String",
+    },
+  ],
+  "updateTime": "A String",
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html index ba142d29f7..e724cc4624 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversationProfiles.html @@ -168,6 +168,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -239,6 +240,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -420,6 +422,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -491,6 +494,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -697,6 +701,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -768,6 +773,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -960,6 +966,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1031,6 +1038,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1231,6 +1239,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1302,6 +1311,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1484,6 +1494,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1555,6 +1566,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html index 15b093711e..c187f81770 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.html @@ -164,6 +164,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -235,6 +236,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -466,6 +468,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -537,6 +540,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -767,6 +771,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -838,6 +843,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1074,6 +1080,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1145,6 +1152,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1440,6 +1448,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -1511,6 +1520,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html index 30fe30df27..4ae69fc567 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.conversations.participants.html @@ -1715,6 +1715,113 @@

Method Details

], "message": "A String", }, + "generateCompanionSuggestionsResponse": { + "answerRecord": "A String", + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, + "latestMessage": "A String", + "suggestionIndex": 42, + }, "generateSuggestionsResponse": { "generatorSuggestionAnswers": [ { @@ -3392,6 +3499,113 @@

Method Details

], "message": "A String", }, + "generateCompanionSuggestionsResponse": { + "answerRecord": "A String", + "companionSuggestion": { + "guidances": [ + { + "explanation": "A String", + "groundingMetadata": { + "groundingChunks": [ + { + "retrievedContext": { + "text": "A String", + "title": "A String", + "uri": "A String", + }, + "web": { + "domain": "A String", + "title": "A String", + "uri": "A String", + }, + }, + ], + "groundingSupports": [ + { + "groundingChunkIndices": [ + 42, + ], + "segment": { + "endIndex": 42, + "startIndex": 42, + "text": "A String", + }, + }, + ], + "searchEntryPoint": { + "renderedContent": "A String", + }, + "webSearchQueries": [ + "A String", + ], + }, + "instructionSource": { + "actions": [ + { + "description": "A String", + }, + ], + "condition": "A String", + "disableSuggestedReply": True or False, + "displayDetails": "A String", + "displayName": "A String", + "triggerEvent": "A String", + }, + "knowledgeSources": [ + { + "knowledgeArticleTitle": "A String", + "knowledgeArticleUrl": "A String", + "knowledgeSnippet": "A String", + }, + ], + "suggestedAction": "A String", + "suggestedReply": "A String", + "toolCalls": [ + { + "textUpdate": "A String", + "toolCallInfo": { + "toolCall": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "createTime": "A String", + "inputParameters": { + "a_key": "", # Properties of the object. + }, + "state": "A String", + "tool": "A String", + "toolDisplayDetails": "A String", + "toolDisplayName": "A String", + }, + "toolCallResult": { + "action": "A String", + "answerRecord": "A String", + "cesApp": "A String", + "cesTool": "A String", + "cesToolset": "A String", + "content": "A String", + "createTime": "A String", + "error": { + "message": "A String", + "retryable": True or False, + }, + "rawContent": "A String", + "tool": "A String", + }, + }, + }, + ], + "triggeringToolCallAnswerRecords": [ + "A String", + ], + }, + ], + }, + "latestMessage": "A String", + "suggestionIndex": 42, + }, "generateSuggestionsResponse": { "generatorSuggestionAnswers": [ { diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.html b/docs/dyn/dialogflow_v2beta1.projects.locations.html index 4413895327..1ca42f3ed4 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.html @@ -84,6 +84,11 @@

Instance Methods

Returns the answerRecords Resource.

+

+ companionAgents() +

+

Returns the companionAgents Resource.

+

conversationProfiles()

diff --git a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html index 6c7b135348..393f859a89 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.locations.suggestions.html @@ -108,6 +108,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -179,6 +180,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html index 89c535957c..a8375c1e7d 100644 --- a/docs/dyn/dialogflow_v2beta1.projects.suggestions.html +++ b/docs/dyn/dialogflow_v2beta1.projects.suggestions.html @@ -108,6 +108,7 @@

Method Details

"displayName": "A String", "humanAgentAssistantConfig": { "endUserSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ @@ -179,6 +180,7 @@

Method Details

"useUnredactedConversationData": True or False, }, "humanAgentSuggestionConfig": { + "companionAgent": "A String", "disableHighLatencyFeaturesSyncDelivery": True or False, "enableAsyncToolCall": True or False, "featureConfigs": [ diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2.json b/googleapiclient/discovery_cache/documents/dialogflow.v2.json index caced8d79d..30995a5290 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2.json @@ -6259,6 +6259,159 @@ } } }, +"companionAgents": { +"methods": { +"create": { +"description": "", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/companionAgents", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.companionAgents.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"companionAgentId": { +"location": "query", +"type": "string" +}, +"parent": { +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/companionAgents", +"request": { +"$ref": "GoogleCloudDialogflowV2CompanionAgent" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2CompanionAgent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"delete": { +"description": "", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/companionAgents/{companionAgentsId}", +"httpMethod": "DELETE", +"id": "dialogflow.projects.locations.companionAgents.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/companionAgents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"get": { +"description": "", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/companionAgents/{companionAgentsId}", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.companionAgents.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/companionAgents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowV2CompanionAgent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"list": { +"description": "", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/companionAgents", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.companionAgents.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"location": "query", +"type": "string" +}, +"parent": { +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}/companionAgents", +"response": { +"$ref": "GoogleCloudDialogflowV2ListCompanionAgentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"patch": { +"description": "", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/companionAgents/{companionAgentsId}", +"httpMethod": "PATCH", +"id": "dialogflow.projects.locations.companionAgents.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/companionAgents/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v2/{+name}", +"request": { +"$ref": "GoogleCloudDialogflowV2CompanionAgent" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2CompanionAgent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +}, "conversationDatasets": { "methods": { "create": { @@ -8780,7 +8933,7 @@ } } }, -"revision": "20260919", +"revision": "20260929", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -12943,6 +13096,9 @@ true ], "type": "string" }, +"companionFeedback": { +"$ref": "GoogleCloudDialogflowV2AgentAssistantFeedbackCompanionFeedback" +}, "documentCorrectness": { "enum": [ "DOCUMENT_CORRECTNESS_UNSPECIFIED", @@ -12981,6 +13137,11 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2AgentAssistantFeedbackCompanionFeedback": { +"id": "GoogleCloudDialogflowV2AgentAssistantFeedbackCompanionFeedback", +"properties": {}, +"type": "object" +}, "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback": { "id": "GoogleCloudDialogflowV2AgentAssistantFeedbackKnowledgeAssistFeedback", "properties": { @@ -13041,6 +13202,10 @@ true "$ref": "GoogleCloudDialogflowV2ArticleAnswer", "readOnly": true }, +"companionSuggestion": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestion", +"readOnly": true +}, "dialogflowAssistAnswer": { "$ref": "GoogleCloudDialogflowV2DialogflowAssistAnswer", "readOnly": true @@ -13052,6 +13217,10 @@ true "generatorSuggestion": { "$ref": "GoogleCloudDialogflowV2GeneratorSuggestion", "readOnly": true +}, +"reactiveCompanionSuggestion": { +"$ref": "GoogleCloudDialogflowV2StreamingReactiveCompanionSuggestionsResponseReactiveModeResponse", +"readOnly": true } }, "type": "object" @@ -13806,6 +13975,177 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2CompanionAgent": { +"id": "GoogleCloudDialogflowV2CompanionAgent", +"properties": { +"cesToolSpecs": { +"items": { +"$ref": "GoogleCloudDialogflowV2CesToolSpec" +}, +"type": "array" +}, +"createTime": { +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"name": { +"type": "string" +}, +"skillConfigs": { +"items": { +"$ref": "GoogleCloudDialogflowV2CompanionAgentSkillConfig" +}, +"type": "array" +}, +"toolsetTools": { +"items": { +"$ref": "GoogleCloudDialogflowV2ToolsetTool" +}, +"type": "array" +}, +"updateTime": { +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionAgentGuidanceSkillConfig": { +"id": "GoogleCloudDialogflowV2CompanionAgentGuidanceSkillConfig", +"properties": { +"guidanceInstructions": { +"items": { +"$ref": "GoogleCloudDialogflowV2GuidanceInstruction" +}, +"type": "array" +}, +"knowledgeSource": { +"$ref": "GoogleCloudDialogflowV2CompanionAgentKnowledgeSource" +}, +"overarchingGuidance": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionAgentKnowledgeSource": { +"id": "GoogleCloudDialogflowV2CompanionAgentKnowledgeSource", +"properties": {}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionAgentSkillConfig": { +"id": "GoogleCloudDialogflowV2CompanionAgentSkillConfig", +"properties": { +"guidanceSkillConfig": { +"$ref": "GoogleCloudDialogflowV2CompanionAgentGuidanceSkillConfig" +}, +"skillTriggeringEvent": { +"enum": [ +"SKILL_TRIGGER_EVENT_UNSPECIFIED", +"END_OF_UTTERANCE", +"CUSTOMER_MESSAGE", +"AGENT_MESSAGE" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +}, +"translationSkillConfig": { +"$ref": "GoogleCloudDialogflowV2CompanionAgentTranslationSkillConfig" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionAgentTranslationSkillConfig": { +"id": "GoogleCloudDialogflowV2CompanionAgentTranslationSkillConfig", +"properties": { +"agentLanguageCode": { +"type": "string" +}, +"customerLanguageCode": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionSuggestion": { +"id": "GoogleCloudDialogflowV2CompanionSuggestion", +"properties": { +"guidances": { +"items": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestionGuidance" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionSuggestionGuidance": { +"id": "GoogleCloudDialogflowV2CompanionSuggestionGuidance", +"properties": { +"explanation": { +"type": "string" +}, +"groundingMetadata": { +"$ref": "GoogleCloudDialogflowV2GroundingMetadata" +}, +"instructionSource": { +"$ref": "GoogleCloudDialogflowV2GuidanceInstruction" +}, +"knowledgeSources": { +"items": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource" +}, +"type": "array" +}, +"suggestedAction": { +"type": "string" +}, +"suggestedReply": { +"type": "string" +}, +"toolCalls": { +"items": { +"$ref": "GoogleCloudDialogflowV2ToolCallSuggestion" +}, +"type": "array" +}, +"triggeringToolCallAnswerRecords": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource": { +"id": "GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource", +"properties": { +"knowledgeArticleTitle": { +"type": "string" +}, +"knowledgeArticleUrl": { +"type": "string" +}, +"knowledgeSnippet": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2CompleteConversationRequest": { "id": "GoogleCloudDialogflowV2CompleteConversationRequest", "properties": {}, @@ -15154,6 +15494,26 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse": { +"id": "GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse", +"properties": { +"answerRecord": { +"type": "string" +}, +"companionSuggestion": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestion" +}, +"latestMessage": { +"type": "string" +}, +"suggestionIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2GenerateStatelessSuggestionRequest": { "id": "GoogleCloudDialogflowV2GenerateStatelessSuggestionRequest", "properties": { @@ -15614,6 +15974,145 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2GroundingChunk": { +"id": "GoogleCloudDialogflowV2GroundingChunk", +"properties": { +"retrievedContext": { +"$ref": "GoogleCloudDialogflowV2GroundingChunkRetrievedContext" +}, +"web": { +"$ref": "GoogleCloudDialogflowV2GroundingChunkWeb" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingChunkRetrievedContext": { +"id": "GoogleCloudDialogflowV2GroundingChunkRetrievedContext", +"properties": { +"text": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingChunkWeb": { +"id": "GoogleCloudDialogflowV2GroundingChunkWeb", +"properties": { +"domain": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingMetadata": { +"id": "GoogleCloudDialogflowV2GroundingMetadata", +"properties": { +"groundingChunks": { +"items": { +"$ref": "GoogleCloudDialogflowV2GroundingChunk" +}, +"type": "array" +}, +"groundingSupports": { +"items": { +"$ref": "GoogleCloudDialogflowV2GroundingSupport" +}, +"type": "array" +}, +"searchEntryPoint": { +"$ref": "GoogleCloudDialogflowV2SearchEntryPoint" +}, +"webSearchQueries": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingSupport": { +"id": "GoogleCloudDialogflowV2GroundingSupport", +"properties": { +"groundingChunkIndices": { +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"segment": { +"$ref": "GoogleCloudDialogflowV2Segment" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GuidanceInstruction": { +"id": "GoogleCloudDialogflowV2GuidanceInstruction", +"properties": { +"actions": { +"items": { +"$ref": "GoogleCloudDialogflowV2GuidanceInstructionAction" +}, +"type": "array" +}, +"condition": { +"type": "string" +}, +"disableSuggestedReply": { +"type": "boolean" +}, +"displayDetails": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"triggerEvent": { +"enum": [ +"TRIGGER_EVENT_UNSPECIFIED", +"END_OF_UTTERANCE", +"CUSTOMER_MESSAGE", +"AGENT_MESSAGE" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GuidanceInstructionAction": { +"id": "GoogleCloudDialogflowV2GuidanceInstructionAction", +"properties": { +"description": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2HumanAgentAssistantConfig": { "id": "GoogleCloudDialogflowV2HumanAgentAssistantConfig", "properties": { @@ -15672,6 +16171,9 @@ true "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig": { "id": "GoogleCloudDialogflowV2HumanAgentAssistantConfigSuggestionConfig", "properties": { +"companionAgent": { +"type": "string" +}, "disableHighLatencyFeaturesSyncDelivery": { "type": "boolean" }, @@ -17476,6 +17978,21 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2ListCompanionAgentsResponse": { +"id": "GoogleCloudDialogflowV2ListCompanionAgentsResponse", +"properties": { +"companionAgents": { +"items": { +"$ref": "GoogleCloudDialogflowV2CompanionAgent" +}, +"type": "array" +}, +"nextPageToken": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2ListContextsResponse": { "id": "GoogleCloudDialogflowV2ListContextsResponse", "properties": { @@ -18280,6 +18797,15 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2SearchEntryPoint": { +"id": "GoogleCloudDialogflowV2SearchEntryPoint", +"properties": { +"renderedContent": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2SearchKnowledgeAnswer": { "id": "GoogleCloudDialogflowV2SearchKnowledgeAnswer", "properties": { @@ -18602,6 +19128,26 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2Segment": { +"id": "GoogleCloudDialogflowV2Segment", +"properties": { +"endIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"startIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"text": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2Sentiment": { "id": "GoogleCloudDialogflowV2Sentiment", "properties": { @@ -19148,6 +19694,24 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2StreamingReactiveCompanionSuggestionsResponseReactiveModeResponse": { +"id": "GoogleCloudDialogflowV2StreamingReactiveCompanionSuggestionsResponseReactiveModeResponse", +"properties": { +"groundingMetadata": { +"$ref": "GoogleCloudDialogflowV2GroundingMetadata" +}, +"response": { +"type": "string" +}, +"toolCalls": { +"items": { +"$ref": "GoogleCloudDialogflowV2ToolCallSuggestion" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2StreamingRecognitionResult": { "id": "GoogleCloudDialogflowV2StreamingRecognitionResult", "properties": { @@ -19497,6 +20061,9 @@ false "error": { "$ref": "GoogleRpcStatus" }, +"generateCompanionSuggestionsResponse": { +"$ref": "GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse" +}, "generateSuggestionsResponse": { "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponse" }, @@ -20278,6 +20845,18 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2ToolCallSuggestion": { +"id": "GoogleCloudDialogflowV2ToolCallSuggestion", +"properties": { +"textUpdate": { +"type": "string" +}, +"toolCallInfo": { +"$ref": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2ToolConnectorTool": { "id": "GoogleCloudDialogflowV2ToolConnectorTool", "properties": { @@ -20965,6 +21544,72 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2beta1CompanionSuggestion": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestion", +"properties": { +"guidances": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance", +"properties": { +"explanation": { +"type": "string" +}, +"groundingMetadata": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingMetadata" +}, +"instructionSource": { +"$ref": "GoogleCloudDialogflowV2beta1GuidanceInstruction" +}, +"knowledgeSources": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource" +}, +"type": "array" +}, +"suggestedAction": { +"type": "string" +}, +"suggestedReply": { +"type": "string" +}, +"toolCalls": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ToolCallSuggestion" +}, +"type": "array" +}, +"triggeringToolCallAnswerRecords": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource", +"properties": { +"knowledgeArticleTitle": { +"type": "string" +}, +"knowledgeArticleUrl": { +"type": "string" +}, +"knowledgeSnippet": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Context": { "id": "GoogleCloudDialogflowV2beta1Context", "properties": { @@ -21200,6 +21845,26 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse": { +"id": "GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse", +"properties": { +"answerRecord": { +"type": "string" +}, +"companionSuggestion": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestion" +}, +"latestMessage": { +"type": "string" +}, +"suggestionIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse": { "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse", "properties": { @@ -21263,6 +21928,145 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2beta1GroundingChunk": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunk", +"properties": { +"retrievedContext": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext" +}, +"web": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunkWeb" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext", +"properties": { +"text": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingChunkWeb": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunkWeb", +"properties": { +"domain": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingMetadata": { +"id": "GoogleCloudDialogflowV2beta1GroundingMetadata", +"properties": { +"groundingChunks": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunk" +}, +"type": "array" +}, +"groundingSupports": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingSupport" +}, +"type": "array" +}, +"searchEntryPoint": { +"$ref": "GoogleCloudDialogflowV2beta1SearchEntryPoint" +}, +"webSearchQueries": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingSupport": { +"id": "GoogleCloudDialogflowV2beta1GroundingSupport", +"properties": { +"groundingChunkIndices": { +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"segment": { +"$ref": "GoogleCloudDialogflowV2beta1Segment" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GuidanceInstruction": { +"id": "GoogleCloudDialogflowV2beta1GuidanceInstruction", +"properties": { +"actions": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GuidanceInstructionAction" +}, +"type": "array" +}, +"condition": { +"type": "string" +}, +"disableSuggestedReply": { +"type": "boolean" +}, +"displayDetails": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"triggerEvent": { +"enum": [ +"TRIGGER_EVENT_UNSPECIFIED", +"END_OF_UTTERANCE", +"CUSTOMER_MESSAGE", +"AGENT_MESSAGE" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GuidanceInstructionAction": { +"id": "GoogleCloudDialogflowV2beta1GuidanceInstructionAction", +"properties": { +"description": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent", "properties": { @@ -23051,6 +23855,35 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SearchEntryPoint": { +"id": "GoogleCloudDialogflowV2beta1SearchEntryPoint", +"properties": { +"renderedContent": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1Segment": { +"id": "GoogleCloudDialogflowV2beta1Segment", +"properties": { +"endIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"startIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"text": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Sentiment": { "id": "GoogleCloudDialogflowV2beta1Sentiment", "properties": { @@ -23385,6 +24218,9 @@ true "error": { "$ref": "GoogleRpcStatus" }, +"generateCompanionSuggestionsResponse": { +"$ref": "GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse" +}, "generateSuggestionsResponse": { "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse" }, @@ -23590,6 +24426,18 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1ToolCallSuggestion": { +"id": "GoogleCloudDialogflowV2beta1ToolCallSuggestion", +"properties": { +"textUpdate": { +"type": "string" +}, +"toolCallInfo": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1WebhookRequest": { "id": "GoogleCloudDialogflowV2beta1WebhookRequest", "properties": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json index 98fb54ad14..025223f9f0 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v2beta1.json @@ -6059,6 +6059,159 @@ } } }, +"companionAgents": { +"methods": { +"create": { +"description": "", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/companionAgents", +"httpMethod": "POST", +"id": "dialogflow.projects.locations.companionAgents.create", +"parameterOrder": [ +"parent" +], +"parameters": { +"companionAgentId": { +"location": "query", +"type": "string" +}, +"parent": { +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+parent}/companionAgents", +"request": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionAgent" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionAgent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"delete": { +"description": "", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/companionAgents/{companionAgentsId}", +"httpMethod": "DELETE", +"id": "dialogflow.projects.locations.companionAgents.delete", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/companionAgents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+name}", +"response": { +"$ref": "GoogleProtobufEmpty" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"get": { +"description": "", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/companionAgents/{companionAgentsId}", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.companionAgents.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/companionAgents/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+name}", +"response": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionAgent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"list": { +"description": "", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/companionAgents", +"httpMethod": "GET", +"id": "dialogflow.projects.locations.companionAgents.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"pageSize": { +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"location": "query", +"type": "string" +}, +"parent": { +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2beta1/{+parent}/companionAgents", +"response": { +"$ref": "GoogleCloudDialogflowV2beta1ListCompanionAgentsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +}, +"patch": { +"description": "", +"flatPath": "v2beta1/projects/{projectsId}/locations/{locationsId}/companionAgents/{companionAgentsId}", +"httpMethod": "PATCH", +"id": "dialogflow.projects.locations.companionAgents.patch", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/companionAgents/[^/]+$", +"required": true, +"type": "string" +}, +"updateMask": { +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v2beta1/{+name}", +"request": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionAgent" +}, +"response": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionAgent" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/dialogflow" +] +} +} +}, "conversationProfiles": { "methods": { "clearSuggestionFeatureConfig": { @@ -8431,7 +8584,7 @@ } } }, -"revision": "20260919", +"revision": "20260929", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -12815,6 +12968,72 @@ }, "type": "object" }, +"GoogleCloudDialogflowV2CompanionSuggestion": { +"id": "GoogleCloudDialogflowV2CompanionSuggestion", +"properties": { +"guidances": { +"items": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestionGuidance" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionSuggestionGuidance": { +"id": "GoogleCloudDialogflowV2CompanionSuggestionGuidance", +"properties": { +"explanation": { +"type": "string" +}, +"groundingMetadata": { +"$ref": "GoogleCloudDialogflowV2GroundingMetadata" +}, +"instructionSource": { +"$ref": "GoogleCloudDialogflowV2GuidanceInstruction" +}, +"knowledgeSources": { +"items": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource" +}, +"type": "array" +}, +"suggestedAction": { +"type": "string" +}, +"suggestedReply": { +"type": "string" +}, +"toolCalls": { +"items": { +"$ref": "GoogleCloudDialogflowV2ToolCallSuggestion" +}, +"type": "array" +}, +"triggeringToolCallAnswerRecords": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource": { +"id": "GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource", +"properties": { +"knowledgeArticleTitle": { +"type": "string" +}, +"knowledgeArticleUrl": { +"type": "string" +}, +"knowledgeSnippet": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2Context": { "id": "GoogleCloudDialogflowV2Context", "properties": { @@ -13222,6 +13441,26 @@ }, "type": "object" }, +"GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse": { +"id": "GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse", +"properties": { +"answerRecord": { +"type": "string" +}, +"companionSuggestion": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestion" +}, +"latestMessage": { +"type": "string" +}, +"suggestionIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2GenerateSuggestionsResponse": { "id": "GoogleCloudDialogflowV2GenerateSuggestionsResponse", "properties": { @@ -13285,91 +13524,230 @@ }, "type": "object" }, -"GoogleCloudDialogflowV2HumanAgentAssistantEvent": { -"id": "GoogleCloudDialogflowV2HumanAgentAssistantEvent", +"GoogleCloudDialogflowV2GroundingChunk": { +"id": "GoogleCloudDialogflowV2GroundingChunk", "properties": { -"conversation": { -"type": "string" -}, -"participant": { -"type": "string" -}, -"suggestionResults": { -"items": { -"$ref": "GoogleCloudDialogflowV2SuggestionResult" +"retrievedContext": { +"$ref": "GoogleCloudDialogflowV2GroundingChunkRetrievedContext" }, -"type": "array" +"web": { +"$ref": "GoogleCloudDialogflowV2GroundingChunkWeb" } }, "type": "object" }, -"GoogleCloudDialogflowV2ImportConversationDataOperationMetadata": { -"id": "GoogleCloudDialogflowV2ImportConversationDataOperationMetadata", +"GoogleCloudDialogflowV2GroundingChunkRetrievedContext": { +"id": "GoogleCloudDialogflowV2GroundingChunkRetrievedContext", "properties": { -"conversationDataset": { +"text": { +"readOnly": true, "type": "string" }, -"createTime": { -"format": "google-datetime", +"title": { +"readOnly": true, "type": "string" }, -"partialFailures": { -"items": { -"$ref": "GoogleRpcStatus" -}, -"type": "array" +"uri": { +"readOnly": true, +"type": "string" } }, "type": "object" }, -"GoogleCloudDialogflowV2ImportConversationDataOperationResponse": { -"id": "GoogleCloudDialogflowV2ImportConversationDataOperationResponse", +"GoogleCloudDialogflowV2GroundingChunkWeb": { +"id": "GoogleCloudDialogflowV2GroundingChunkWeb", "properties": { -"conversationDataset": { +"domain": { +"readOnly": true, "type": "string" }, -"importCount": { -"format": "int32", -"type": "integer" +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" } }, "type": "object" }, -"GoogleCloudDialogflowV2ImportDocumentsResponse": { -"id": "GoogleCloudDialogflowV2ImportDocumentsResponse", +"GoogleCloudDialogflowV2GroundingMetadata": { +"id": "GoogleCloudDialogflowV2GroundingMetadata", "properties": { -"warnings": { +"groundingChunks": { "items": { -"$ref": "GoogleRpcStatus" +"$ref": "GoogleCloudDialogflowV2GroundingChunk" }, "type": "array" -} }, -"type": "object" +"groundingSupports": { +"items": { +"$ref": "GoogleCloudDialogflowV2GroundingSupport" }, -"GoogleCloudDialogflowV2IngestedContextReferenceDebugInfo": { -"id": "GoogleCloudDialogflowV2IngestedContextReferenceDebugInfo", -"properties": { -"contextReferenceRetrieved": { -"type": "boolean" +"type": "array" }, -"ingestedParametersDebugInfo": { +"searchEntryPoint": { +"$ref": "GoogleCloudDialogflowV2SearchEntryPoint" +}, +"webSearchQueries": { "items": { -"$ref": "GoogleCloudDialogflowV2IngestedContextReferenceDebugInfoIngestedParameterDebugInfo" +"type": "string" }, "type": "array" -}, -"projectNotAllowlisted": { -"type": "boolean" } }, "type": "object" }, -"GoogleCloudDialogflowV2IngestedContextReferenceDebugInfoIngestedParameterDebugInfo": { -"id": "GoogleCloudDialogflowV2IngestedContextReferenceDebugInfoIngestedParameterDebugInfo", +"GoogleCloudDialogflowV2GroundingSupport": { +"id": "GoogleCloudDialogflowV2GroundingSupport", "properties": { -"ingestionStatus": { -"enum": [ +"groundingChunkIndices": { +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"segment": { +"$ref": "GoogleCloudDialogflowV2Segment" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GuidanceInstruction": { +"id": "GoogleCloudDialogflowV2GuidanceInstruction", +"properties": { +"actions": { +"items": { +"$ref": "GoogleCloudDialogflowV2GuidanceInstructionAction" +}, +"type": "array" +}, +"condition": { +"type": "string" +}, +"disableSuggestedReply": { +"type": "boolean" +}, +"displayDetails": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"triggerEvent": { +"enum": [ +"TRIGGER_EVENT_UNSPECIFIED", +"END_OF_UTTERANCE", +"CUSTOMER_MESSAGE", +"AGENT_MESSAGE" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GuidanceInstructionAction": { +"id": "GoogleCloudDialogflowV2GuidanceInstructionAction", +"properties": { +"description": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2HumanAgentAssistantEvent": { +"id": "GoogleCloudDialogflowV2HumanAgentAssistantEvent", +"properties": { +"conversation": { +"type": "string" +}, +"participant": { +"type": "string" +}, +"suggestionResults": { +"items": { +"$ref": "GoogleCloudDialogflowV2SuggestionResult" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2ImportConversationDataOperationMetadata": { +"id": "GoogleCloudDialogflowV2ImportConversationDataOperationMetadata", +"properties": { +"conversationDataset": { +"type": "string" +}, +"createTime": { +"format": "google-datetime", +"type": "string" +}, +"partialFailures": { +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2ImportConversationDataOperationResponse": { +"id": "GoogleCloudDialogflowV2ImportConversationDataOperationResponse", +"properties": { +"conversationDataset": { +"type": "string" +}, +"importCount": { +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2ImportDocumentsResponse": { +"id": "GoogleCloudDialogflowV2ImportDocumentsResponse", +"properties": { +"warnings": { +"items": { +"$ref": "GoogleRpcStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2IngestedContextReferenceDebugInfo": { +"id": "GoogleCloudDialogflowV2IngestedContextReferenceDebugInfo", +"properties": { +"contextReferenceRetrieved": { +"type": "boolean" +}, +"ingestedParametersDebugInfo": { +"items": { +"$ref": "GoogleCloudDialogflowV2IngestedContextReferenceDebugInfoIngestedParameterDebugInfo" +}, +"type": "array" +}, +"projectNotAllowlisted": { +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2IngestedContextReferenceDebugInfoIngestedParameterDebugInfo": { +"id": "GoogleCloudDialogflowV2IngestedContextReferenceDebugInfoIngestedParameterDebugInfo", +"properties": { +"ingestionStatus": { +"enum": [ "INGESTION_STATUS_UNSPECIFIED", "INGESTION_STATUS_SUCCEEDED", "INGESTION_STATUS_CONTEXT_NOT_AVAILABLE", @@ -14699,6 +15077,35 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SearchEntryPoint": { +"id": "GoogleCloudDialogflowV2SearchEntryPoint", +"properties": { +"renderedContent": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2Segment": { +"id": "GoogleCloudDialogflowV2Segment", +"properties": { +"endIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"startIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"text": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2Sentiment": { "id": "GoogleCloudDialogflowV2Sentiment", "properties": { @@ -15025,6 +15432,9 @@ true "error": { "$ref": "GoogleRpcStatus" }, +"generateCompanionSuggestionsResponse": { +"$ref": "GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse" +}, "generateSuggestionsResponse": { "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponse" }, @@ -15174,6 +15584,18 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2ToolCallSuggestion": { +"id": "GoogleCloudDialogflowV2ToolCallSuggestion", +"properties": { +"textUpdate": { +"type": "string" +}, +"toolCallInfo": { +"$ref": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata": { "id": "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata", "properties": { @@ -15352,6 +15774,9 @@ true ], "type": "string" }, +"companionFeedback": { +"$ref": "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackCompanionFeedback" +}, "documentCorrectness": { "enum": [ "DOCUMENT_CORRECTNESS_UNSPECIFIED", @@ -15390,6 +15815,11 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1AgentAssistantFeedbackCompanionFeedback": { +"id": "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackCompanionFeedback", +"properties": {}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeAssistFeedback": { "id": "GoogleCloudDialogflowV2beta1AgentAssistantFeedbackKnowledgeAssistFeedback", "properties": { @@ -15450,6 +15880,10 @@ true "$ref": "GoogleCloudDialogflowV2beta1ArticleAnswer", "readOnly": true }, +"companionSuggestion": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestion", +"readOnly": true +}, "dialogflowAssistAnswer": { "$ref": "GoogleCloudDialogflowV2beta1DialogflowAssistAnswer", "readOnly": true @@ -15461,6 +15895,10 @@ true "generatorSuggestion": { "$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestion", "readOnly": true +}, +"reactiveCompanionSuggestion": { +"$ref": "GoogleCloudDialogflowV2beta1StreamingReactiveCompanionSuggestionsResponseReactiveModeResponse", +"readOnly": true } }, "type": "object" @@ -16278,6 +16716,162 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1CompanionAgent": { +"id": "GoogleCloudDialogflowV2beta1CompanionAgent", +"properties": { +"cesToolSpecs": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1CesToolSpec" +}, +"type": "array" +}, +"createTime": { +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"description": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"name": { +"type": "string" +}, +"skillConfigs": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionAgentSkillConfig" +}, +"type": "array" +}, +"toolsetTools": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ToolsetTool" +}, +"type": "array" +}, +"updateTime": { +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionAgentGuidanceSkillConfig": { +"id": "GoogleCloudDialogflowV2beta1CompanionAgentGuidanceSkillConfig", +"properties": { +"guidanceInstructions": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GuidanceInstruction" +}, +"type": "array" +}, +"knowledgeSource": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionAgentKnowledgeSource" +}, +"overarchingGuidance": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionAgentKnowledgeSource": { +"id": "GoogleCloudDialogflowV2beta1CompanionAgentKnowledgeSource", +"properties": {}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionAgentSkillConfig": { +"id": "GoogleCloudDialogflowV2beta1CompanionAgentSkillConfig", +"properties": { +"guidanceSkillConfig": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionAgentGuidanceSkillConfig" +}, +"skillTriggeringEvent": { +"enum": [ +"SKILL_TRIGGER_EVENT_UNSPECIFIED", +"END_OF_UTTERANCE", +"CUSTOMER_MESSAGE", +"AGENT_MESSAGE" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionSuggestion": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestion", +"properties": { +"guidances": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance", +"properties": { +"explanation": { +"type": "string" +}, +"groundingMetadata": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingMetadata" +}, +"instructionSource": { +"$ref": "GoogleCloudDialogflowV2beta1GuidanceInstruction" +}, +"knowledgeSources": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource" +}, +"type": "array" +}, +"suggestedAction": { +"type": "string" +}, +"suggestedReply": { +"type": "string" +}, +"toolCalls": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ToolCallSuggestion" +}, +"type": "array" +}, +"triggeringToolCallAnswerRecords": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource", +"properties": { +"knowledgeArticleTitle": { +"type": "string" +}, +"knowledgeArticleUrl": { +"type": "string" +}, +"knowledgeSnippet": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1CompileSuggestionRequest": { "deprecated": true, "id": "GoogleCloudDialogflowV2beta1CompileSuggestionRequest", @@ -17354,6 +17948,26 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse": { +"id": "GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse", +"properties": { +"answerRecord": { +"type": "string" +}, +"companionSuggestion": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestion" +}, +"latestMessage": { +"type": "string" +}, +"suggestionIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1GenerateStatelessSuggestionRequest": { "id": "GoogleCloudDialogflowV2beta1GenerateStatelessSuggestionRequest", "properties": { @@ -17814,6 +18428,145 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1GroundingChunk": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunk", +"properties": { +"retrievedContext": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext" +}, +"web": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunkWeb" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext", +"properties": { +"text": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingChunkWeb": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunkWeb", +"properties": { +"domain": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingMetadata": { +"id": "GoogleCloudDialogflowV2beta1GroundingMetadata", +"properties": { +"groundingChunks": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunk" +}, +"type": "array" +}, +"groundingSupports": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingSupport" +}, +"type": "array" +}, +"searchEntryPoint": { +"$ref": "GoogleCloudDialogflowV2beta1SearchEntryPoint" +}, +"webSearchQueries": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingSupport": { +"id": "GoogleCloudDialogflowV2beta1GroundingSupport", +"properties": { +"groundingChunkIndices": { +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"segment": { +"$ref": "GoogleCloudDialogflowV2beta1Segment" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GuidanceInstruction": { +"id": "GoogleCloudDialogflowV2beta1GuidanceInstruction", +"properties": { +"actions": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GuidanceInstructionAction" +}, +"type": "array" +}, +"condition": { +"type": "string" +}, +"disableSuggestedReply": { +"type": "boolean" +}, +"displayDetails": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"triggerEvent": { +"enum": [ +"TRIGGER_EVENT_UNSPECIFIED", +"END_OF_UTTERANCE", +"CUSTOMER_MESSAGE", +"AGENT_MESSAGE" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GuidanceInstructionAction": { +"id": "GoogleCloudDialogflowV2beta1GuidanceInstructionAction", +"properties": { +"description": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfig", "properties": { @@ -17860,6 +18613,9 @@ true "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionConfig": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionConfig", "properties": { +"companionAgent": { +"type": "string" +}, "disableHighLatencyFeaturesSyncDelivery": { "type": "boolean" }, @@ -19916,6 +20672,21 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1ListCompanionAgentsResponse": { +"id": "GoogleCloudDialogflowV2beta1ListCompanionAgentsResponse", +"properties": { +"companionAgents": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionAgent" +}, +"type": "array" +}, +"nextPageToken": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1ListContextsResponse": { "id": "GoogleCloudDialogflowV2beta1ListContextsResponse", "properties": { @@ -20878,6 +21649,15 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SearchEntryPoint": { +"id": "GoogleCloudDialogflowV2beta1SearchEntryPoint", +"properties": { +"renderedContent": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1SearchKnowledgeAnswer": { "id": "GoogleCloudDialogflowV2beta1SearchKnowledgeAnswer", "properties": { @@ -21200,6 +21980,26 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2beta1Segment": { +"id": "GoogleCloudDialogflowV2beta1Segment", +"properties": { +"endIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"startIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"text": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Sentiment": { "id": "GoogleCloudDialogflowV2beta1Sentiment", "properties": { @@ -21695,6 +22495,24 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2beta1StreamingReactiveCompanionSuggestionsResponseReactiveModeResponse": { +"id": "GoogleCloudDialogflowV2beta1StreamingReactiveCompanionSuggestionsResponseReactiveModeResponse", +"properties": { +"groundingMetadata": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingMetadata" +}, +"response": { +"type": "string" +}, +"toolCalls": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ToolCallSuggestion" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1StreamingRecognitionResult": { "id": "GoogleCloudDialogflowV2beta1StreamingRecognitionResult", "properties": { @@ -22173,6 +22991,9 @@ false "error": { "$ref": "GoogleRpcStatus" }, +"generateCompanionSuggestionsResponse": { +"$ref": "GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse" +}, "generateSuggestionsResponse": { "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse" }, @@ -23010,6 +23831,18 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2beta1ToolCallSuggestion": { +"id": "GoogleCloudDialogflowV2beta1ToolCallSuggestion", +"properties": { +"textUpdate": { +"type": "string" +}, +"toolCallInfo": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1ToolConnectorTool": { "id": "GoogleCloudDialogflowV2beta1ToolConnectorTool", "properties": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3.json b/googleapiclient/discovery_cache/documents/dialogflow.v3.json index a0ce7dc756..af4b26a1a3 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3.json @@ -5031,7 +5031,7 @@ } } }, -"revision": "20260815", +"revision": "20260929", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3Action": { @@ -13633,6 +13633,72 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2CompanionSuggestion": { +"id": "GoogleCloudDialogflowV2CompanionSuggestion", +"properties": { +"guidances": { +"items": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestionGuidance" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionSuggestionGuidance": { +"id": "GoogleCloudDialogflowV2CompanionSuggestionGuidance", +"properties": { +"explanation": { +"type": "string" +}, +"groundingMetadata": { +"$ref": "GoogleCloudDialogflowV2GroundingMetadata" +}, +"instructionSource": { +"$ref": "GoogleCloudDialogflowV2GuidanceInstruction" +}, +"knowledgeSources": { +"items": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource" +}, +"type": "array" +}, +"suggestedAction": { +"type": "string" +}, +"suggestedReply": { +"type": "string" +}, +"toolCalls": { +"items": { +"$ref": "GoogleCloudDialogflowV2ToolCallSuggestion" +}, +"type": "array" +}, +"triggeringToolCallAnswerRecords": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource": { +"id": "GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource", +"properties": { +"knowledgeArticleTitle": { +"type": "string" +}, +"knowledgeArticleUrl": { +"type": "string" +}, +"knowledgeSnippet": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2Context": { "id": "GoogleCloudDialogflowV2Context", "properties": { @@ -14040,6 +14106,26 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse": { +"id": "GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse", +"properties": { +"answerRecord": { +"type": "string" +}, +"companionSuggestion": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestion" +}, +"latestMessage": { +"type": "string" +}, +"suggestionIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2GenerateSuggestionsResponse": { "id": "GoogleCloudDialogflowV2GenerateSuggestionsResponse", "properties": { @@ -14103,6 +14189,145 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2GroundingChunk": { +"id": "GoogleCloudDialogflowV2GroundingChunk", +"properties": { +"retrievedContext": { +"$ref": "GoogleCloudDialogflowV2GroundingChunkRetrievedContext" +}, +"web": { +"$ref": "GoogleCloudDialogflowV2GroundingChunkWeb" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingChunkRetrievedContext": { +"id": "GoogleCloudDialogflowV2GroundingChunkRetrievedContext", +"properties": { +"text": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingChunkWeb": { +"id": "GoogleCloudDialogflowV2GroundingChunkWeb", +"properties": { +"domain": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingMetadata": { +"id": "GoogleCloudDialogflowV2GroundingMetadata", +"properties": { +"groundingChunks": { +"items": { +"$ref": "GoogleCloudDialogflowV2GroundingChunk" +}, +"type": "array" +}, +"groundingSupports": { +"items": { +"$ref": "GoogleCloudDialogflowV2GroundingSupport" +}, +"type": "array" +}, +"searchEntryPoint": { +"$ref": "GoogleCloudDialogflowV2SearchEntryPoint" +}, +"webSearchQueries": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingSupport": { +"id": "GoogleCloudDialogflowV2GroundingSupport", +"properties": { +"groundingChunkIndices": { +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"segment": { +"$ref": "GoogleCloudDialogflowV2Segment" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GuidanceInstruction": { +"id": "GoogleCloudDialogflowV2GuidanceInstruction", +"properties": { +"actions": { +"items": { +"$ref": "GoogleCloudDialogflowV2GuidanceInstructionAction" +}, +"type": "array" +}, +"condition": { +"type": "string" +}, +"disableSuggestedReply": { +"type": "boolean" +}, +"displayDetails": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"triggerEvent": { +"enum": [ +"TRIGGER_EVENT_UNSPECIFIED", +"END_OF_UTTERANCE", +"CUSTOMER_MESSAGE", +"AGENT_MESSAGE" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GuidanceInstructionAction": { +"id": "GoogleCloudDialogflowV2GuidanceInstructionAction", +"properties": { +"description": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2HumanAgentAssistantEvent": { "id": "GoogleCloudDialogflowV2HumanAgentAssistantEvent", "properties": { @@ -15517,6 +15742,35 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SearchEntryPoint": { +"id": "GoogleCloudDialogflowV2SearchEntryPoint", +"properties": { +"renderedContent": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2Segment": { +"id": "GoogleCloudDialogflowV2Segment", +"properties": { +"endIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"startIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"text": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2Sentiment": { "id": "GoogleCloudDialogflowV2Sentiment", "properties": { @@ -15843,6 +16097,9 @@ true "error": { "$ref": "GoogleRpcStatus" }, +"generateCompanionSuggestionsResponse": { +"$ref": "GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse" +}, "generateSuggestionsResponse": { "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponse" }, @@ -15992,6 +16249,18 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2ToolCallSuggestion": { +"id": "GoogleCloudDialogflowV2ToolCallSuggestion", +"properties": { +"textUpdate": { +"type": "string" +}, +"toolCallInfo": { +"$ref": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata": { "id": "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata", "properties": { @@ -16370,6 +16639,72 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1CompanionSuggestion": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestion", +"properties": { +"guidances": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance", +"properties": { +"explanation": { +"type": "string" +}, +"groundingMetadata": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingMetadata" +}, +"instructionSource": { +"$ref": "GoogleCloudDialogflowV2beta1GuidanceInstruction" +}, +"knowledgeSources": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource" +}, +"type": "array" +}, +"suggestedAction": { +"type": "string" +}, +"suggestedReply": { +"type": "string" +}, +"toolCalls": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ToolCallSuggestion" +}, +"type": "array" +}, +"triggeringToolCallAnswerRecords": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource", +"properties": { +"knowledgeArticleTitle": { +"type": "string" +}, +"knowledgeArticleUrl": { +"type": "string" +}, +"knowledgeSnippet": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Context": { "id": "GoogleCloudDialogflowV2beta1Context", "properties": { @@ -16605,6 +16940,26 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse": { +"id": "GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse", +"properties": { +"answerRecord": { +"type": "string" +}, +"companionSuggestion": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestion" +}, +"latestMessage": { +"type": "string" +}, +"suggestionIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse": { "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse", "properties": { @@ -16668,6 +17023,145 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1GroundingChunk": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunk", +"properties": { +"retrievedContext": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext" +}, +"web": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunkWeb" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext", +"properties": { +"text": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingChunkWeb": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunkWeb", +"properties": { +"domain": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingMetadata": { +"id": "GoogleCloudDialogflowV2beta1GroundingMetadata", +"properties": { +"groundingChunks": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunk" +}, +"type": "array" +}, +"groundingSupports": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingSupport" +}, +"type": "array" +}, +"searchEntryPoint": { +"$ref": "GoogleCloudDialogflowV2beta1SearchEntryPoint" +}, +"webSearchQueries": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingSupport": { +"id": "GoogleCloudDialogflowV2beta1GroundingSupport", +"properties": { +"groundingChunkIndices": { +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"segment": { +"$ref": "GoogleCloudDialogflowV2beta1Segment" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GuidanceInstruction": { +"id": "GoogleCloudDialogflowV2beta1GuidanceInstruction", +"properties": { +"actions": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GuidanceInstructionAction" +}, +"type": "array" +}, +"condition": { +"type": "string" +}, +"disableSuggestedReply": { +"type": "boolean" +}, +"displayDetails": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"triggerEvent": { +"enum": [ +"TRIGGER_EVENT_UNSPECIFIED", +"END_OF_UTTERANCE", +"CUSTOMER_MESSAGE", +"AGENT_MESSAGE" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GuidanceInstructionAction": { +"id": "GoogleCloudDialogflowV2beta1GuidanceInstructionAction", +"properties": { +"description": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent", "properties": { @@ -18456,6 +18950,35 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SearchEntryPoint": { +"id": "GoogleCloudDialogflowV2beta1SearchEntryPoint", +"properties": { +"renderedContent": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1Segment": { +"id": "GoogleCloudDialogflowV2beta1Segment", +"properties": { +"endIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"startIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"text": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Sentiment": { "id": "GoogleCloudDialogflowV2beta1Sentiment", "properties": { @@ -18790,6 +19313,9 @@ true "error": { "$ref": "GoogleRpcStatus" }, +"generateCompanionSuggestionsResponse": { +"$ref": "GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse" +}, "generateSuggestionsResponse": { "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse" }, @@ -18995,6 +19521,18 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1ToolCallSuggestion": { +"id": "GoogleCloudDialogflowV2beta1ToolCallSuggestion", +"properties": { +"textUpdate": { +"type": "string" +}, +"toolCallInfo": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1WebhookRequest": { "id": "GoogleCloudDialogflowV2beta1WebhookRequest", "properties": { diff --git a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json index 570040b286..e999859392 100644 --- a/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json +++ b/googleapiclient/discovery_cache/documents/dialogflow.v3beta1.json @@ -5151,7 +5151,7 @@ } } }, -"revision": "20260815", +"revision": "20260929", "rootUrl": "https://dialogflow.googleapis.com/", "schemas": { "GoogleCloudDialogflowCxV3AdvancedSettings": { @@ -14678,6 +14678,72 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2CompanionSuggestion": { +"id": "GoogleCloudDialogflowV2CompanionSuggestion", +"properties": { +"guidances": { +"items": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestionGuidance" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionSuggestionGuidance": { +"id": "GoogleCloudDialogflowV2CompanionSuggestionGuidance", +"properties": { +"explanation": { +"type": "string" +}, +"groundingMetadata": { +"$ref": "GoogleCloudDialogflowV2GroundingMetadata" +}, +"instructionSource": { +"$ref": "GoogleCloudDialogflowV2GuidanceInstruction" +}, +"knowledgeSources": { +"items": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource" +}, +"type": "array" +}, +"suggestedAction": { +"type": "string" +}, +"suggestedReply": { +"type": "string" +}, +"toolCalls": { +"items": { +"$ref": "GoogleCloudDialogflowV2ToolCallSuggestion" +}, +"type": "array" +}, +"triggeringToolCallAnswerRecords": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource": { +"id": "GoogleCloudDialogflowV2CompanionSuggestionGuidanceKnowledgeSource", +"properties": { +"knowledgeArticleTitle": { +"type": "string" +}, +"knowledgeArticleUrl": { +"type": "string" +}, +"knowledgeSnippet": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2Context": { "id": "GoogleCloudDialogflowV2Context", "properties": { @@ -15085,6 +15151,26 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse": { +"id": "GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse", +"properties": { +"answerRecord": { +"type": "string" +}, +"companionSuggestion": { +"$ref": "GoogleCloudDialogflowV2CompanionSuggestion" +}, +"latestMessage": { +"type": "string" +}, +"suggestionIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2GenerateSuggestionsResponse": { "id": "GoogleCloudDialogflowV2GenerateSuggestionsResponse", "properties": { @@ -15148,6 +15234,145 @@ false }, "type": "object" }, +"GoogleCloudDialogflowV2GroundingChunk": { +"id": "GoogleCloudDialogflowV2GroundingChunk", +"properties": { +"retrievedContext": { +"$ref": "GoogleCloudDialogflowV2GroundingChunkRetrievedContext" +}, +"web": { +"$ref": "GoogleCloudDialogflowV2GroundingChunkWeb" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingChunkRetrievedContext": { +"id": "GoogleCloudDialogflowV2GroundingChunkRetrievedContext", +"properties": { +"text": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingChunkWeb": { +"id": "GoogleCloudDialogflowV2GroundingChunkWeb", +"properties": { +"domain": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingMetadata": { +"id": "GoogleCloudDialogflowV2GroundingMetadata", +"properties": { +"groundingChunks": { +"items": { +"$ref": "GoogleCloudDialogflowV2GroundingChunk" +}, +"type": "array" +}, +"groundingSupports": { +"items": { +"$ref": "GoogleCloudDialogflowV2GroundingSupport" +}, +"type": "array" +}, +"searchEntryPoint": { +"$ref": "GoogleCloudDialogflowV2SearchEntryPoint" +}, +"webSearchQueries": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GroundingSupport": { +"id": "GoogleCloudDialogflowV2GroundingSupport", +"properties": { +"groundingChunkIndices": { +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"segment": { +"$ref": "GoogleCloudDialogflowV2Segment" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GuidanceInstruction": { +"id": "GoogleCloudDialogflowV2GuidanceInstruction", +"properties": { +"actions": { +"items": { +"$ref": "GoogleCloudDialogflowV2GuidanceInstructionAction" +}, +"type": "array" +}, +"condition": { +"type": "string" +}, +"disableSuggestedReply": { +"type": "boolean" +}, +"displayDetails": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"triggerEvent": { +"enum": [ +"TRIGGER_EVENT_UNSPECIFIED", +"END_OF_UTTERANCE", +"CUSTOMER_MESSAGE", +"AGENT_MESSAGE" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2GuidanceInstructionAction": { +"id": "GoogleCloudDialogflowV2GuidanceInstructionAction", +"properties": { +"description": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2HumanAgentAssistantEvent": { "id": "GoogleCloudDialogflowV2HumanAgentAssistantEvent", "properties": { @@ -16562,6 +16787,35 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2SearchEntryPoint": { +"id": "GoogleCloudDialogflowV2SearchEntryPoint", +"properties": { +"renderedContent": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2Segment": { +"id": "GoogleCloudDialogflowV2Segment", +"properties": { +"endIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"startIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"text": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2Sentiment": { "id": "GoogleCloudDialogflowV2Sentiment", "properties": { @@ -16888,6 +17142,9 @@ true "error": { "$ref": "GoogleRpcStatus" }, +"generateCompanionSuggestionsResponse": { +"$ref": "GoogleCloudDialogflowV2GenerateCompanionSuggestionsResponse" +}, "generateSuggestionsResponse": { "$ref": "GoogleCloudDialogflowV2GenerateSuggestionsResponse" }, @@ -17037,6 +17294,18 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2ToolCallSuggestion": { +"id": "GoogleCloudDialogflowV2ToolCallSuggestion", +"properties": { +"textUpdate": { +"type": "string" +}, +"toolCallInfo": { +"$ref": "GoogleCloudDialogflowV2GeneratorSuggestionToolCallInfo" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata": { "id": "GoogleCloudDialogflowV2UndeployConversationModelOperationMetadata", "properties": { @@ -17415,6 +17684,72 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1CompanionSuggestion": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestion", +"properties": { +"guidances": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidance", +"properties": { +"explanation": { +"type": "string" +}, +"groundingMetadata": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingMetadata" +}, +"instructionSource": { +"$ref": "GoogleCloudDialogflowV2beta1GuidanceInstruction" +}, +"knowledgeSources": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource" +}, +"type": "array" +}, +"suggestedAction": { +"type": "string" +}, +"suggestedReply": { +"type": "string" +}, +"toolCalls": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1ToolCallSuggestion" +}, +"type": "array" +}, +"triggeringToolCallAnswerRecords": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource": { +"id": "GoogleCloudDialogflowV2beta1CompanionSuggestionGuidanceKnowledgeSource", +"properties": { +"knowledgeArticleTitle": { +"type": "string" +}, +"knowledgeArticleUrl": { +"type": "string" +}, +"knowledgeSnippet": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Context": { "id": "GoogleCloudDialogflowV2beta1Context", "properties": { @@ -17650,6 +17985,26 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse": { +"id": "GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse", +"properties": { +"answerRecord": { +"type": "string" +}, +"companionSuggestion": { +"$ref": "GoogleCloudDialogflowV2beta1CompanionSuggestion" +}, +"latestMessage": { +"type": "string" +}, +"suggestionIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse": { "id": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse", "properties": { @@ -17713,6 +18068,145 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1GroundingChunk": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunk", +"properties": { +"retrievedContext": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext" +}, +"web": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunkWeb" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunkRetrievedContext", +"properties": { +"text": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingChunkWeb": { +"id": "GoogleCloudDialogflowV2beta1GroundingChunkWeb", +"properties": { +"domain": { +"readOnly": true, +"type": "string" +}, +"title": { +"readOnly": true, +"type": "string" +}, +"uri": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingMetadata": { +"id": "GoogleCloudDialogflowV2beta1GroundingMetadata", +"properties": { +"groundingChunks": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingChunk" +}, +"type": "array" +}, +"groundingSupports": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GroundingSupport" +}, +"type": "array" +}, +"searchEntryPoint": { +"$ref": "GoogleCloudDialogflowV2beta1SearchEntryPoint" +}, +"webSearchQueries": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GroundingSupport": { +"id": "GoogleCloudDialogflowV2beta1GroundingSupport", +"properties": { +"groundingChunkIndices": { +"items": { +"format": "int32", +"type": "integer" +}, +"type": "array" +}, +"segment": { +"$ref": "GoogleCloudDialogflowV2beta1Segment" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GuidanceInstruction": { +"id": "GoogleCloudDialogflowV2beta1GuidanceInstruction", +"properties": { +"actions": { +"items": { +"$ref": "GoogleCloudDialogflowV2beta1GuidanceInstructionAction" +}, +"type": "array" +}, +"condition": { +"type": "string" +}, +"disableSuggestedReply": { +"type": "boolean" +}, +"displayDetails": { +"type": "string" +}, +"displayName": { +"type": "string" +}, +"triggerEvent": { +"enum": [ +"TRIGGER_EVENT_UNSPECIFIED", +"END_OF_UTTERANCE", +"CUSTOMER_MESSAGE", +"AGENT_MESSAGE" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1GuidanceInstructionAction": { +"id": "GoogleCloudDialogflowV2beta1GuidanceInstructionAction", +"properties": { +"description": { +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent": { "id": "GoogleCloudDialogflowV2beta1HumanAgentAssistantEvent", "properties": { @@ -19501,6 +19995,35 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1SearchEntryPoint": { +"id": "GoogleCloudDialogflowV2beta1SearchEntryPoint", +"properties": { +"renderedContent": { +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudDialogflowV2beta1Segment": { +"id": "GoogleCloudDialogflowV2beta1Segment", +"properties": { +"endIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"startIndex": { +"format": "int32", +"readOnly": true, +"type": "integer" +}, +"text": { +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1Sentiment": { "id": "GoogleCloudDialogflowV2beta1Sentiment", "properties": { @@ -19835,6 +20358,9 @@ true "error": { "$ref": "GoogleRpcStatus" }, +"generateCompanionSuggestionsResponse": { +"$ref": "GoogleCloudDialogflowV2beta1GenerateCompanionSuggestionsResponse" +}, "generateSuggestionsResponse": { "$ref": "GoogleCloudDialogflowV2beta1GenerateSuggestionsResponse" }, @@ -20040,6 +20566,18 @@ true }, "type": "object" }, +"GoogleCloudDialogflowV2beta1ToolCallSuggestion": { +"id": "GoogleCloudDialogflowV2beta1ToolCallSuggestion", +"properties": { +"textUpdate": { +"type": "string" +}, +"toolCallInfo": { +"$ref": "GoogleCloudDialogflowV2beta1GeneratorSuggestionToolCallInfo" +} +}, +"type": "object" +}, "GoogleCloudDialogflowV2beta1WebhookRequest": { "id": "GoogleCloudDialogflowV2beta1WebhookRequest", "properties": { From 1ba4e0e91c54ab844ab3ec4716d2c106692100c5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:37 +0000 Subject: [PATCH 19/41] feat(docs): update the api #### docs:v1 The following keys were added: - schemas.CreateDropdownDefinitionRequest (Total Keys: 4) - schemas.CreateDropdownDefinitionResponse (Total Keys: 3) - schemas.DeleteDropdownDefinitionRequest (Total Keys: 4) - schemas.DocumentTab.properties.dropdownDefinitions (Total Keys: 2) - schemas.Dropdown (Total Keys: 41) - schemas.InsertDropdownRequest (Total Keys: 6) - schemas.InsertDropdownResponse (Total Keys: 3) - schemas.ParagraphElement.properties.dropdown.$ref (Total Keys: 1) - schemas.Request.properties.createDropdownDefinition.$ref (Total Keys: 1) - schemas.Request.properties.deleteDropdownDefinition.$ref (Total Keys: 1) - schemas.Request.properties.insertDropdown.$ref (Total Keys: 1) - schemas.Request.properties.updateDropdownDefinitionProperties.$ref (Total Keys: 1) - schemas.Request.properties.updateDropdownProperties.$ref (Total Keys: 1) - schemas.Response.properties.createDropdownDefinition.$ref (Total Keys: 1) - schemas.Response.properties.insertDropdown.$ref (Total Keys: 1) - schemas.SuggestedDropdownDefinitionProperties (Total Keys: 4) - schemas.SuggestedDropdownProperties (Total Keys: 4) - schemas.UpdateDropdownDefinitionPropertiesRequest (Total Keys: 9) - schemas.UpdateDropdownPropertiesRequest (Total Keys: 7) --- docs/dyn/docs_v1.documents.html | 7947 +++++++++++++---- .../discovery_cache/documents/docs.v1.json | 360 +- 2 files changed, 6440 insertions(+), 1867 deletions(-) diff --git a/docs/dyn/docs_v1.documents.html b/docs/dyn/docs_v1.documents.html index f750a24fce..962014abc8 100644 --- a/docs/dyn/docs_v1.documents.html +++ b/docs/dyn/docs_v1.documents.html @@ -136,6 +136,136 @@

Method Details

"title": "A String", # The user-visible name of the tab. }, }, + "createDropdownDefinition": { # Creates a new DropdownDefinition in the document. # Creates a DropdownDefinition. + "dropdownDefinition": { # A dropdown definition in the document. # Required. The DropdownDefinition to create. + "dropdownDefinitionId": "A String", # The ID of this dropdown definition. If you specify an ID, it must be unique among all IDs in the tab. The ID must start with `kix.` and match regex `^kix\.[a-zA-Z0-9_-]{2,14}$` (length 6-18 chars). If you don't specify an ID, a unique one is generated. + "dropdownDefinitionProperties": { # Properties of a dropdown definition. # The properties of this dropdown definition. + "options": [ # The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. + { # An option in a Dropdown. + "displayValue": "A String", # The display value of this dropdown option. + "optionId": "A String", # The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + "title": "A String", # The title of the dropdown definition. + }, + "suggestedDeletionId": "A String", # ID for suggestion that deletes this dropdown definition. + "suggestedDropdownDefinitionPropertiesChanges": { # Suggested property changes to this definition, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown definition properties. + "dropdownDefinitionProperties": { # Properties of a dropdown definition. # A DropdownDefinitionProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_definition_properties_suggestion_state to see which fields have changed and their new values. + "options": [ # The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. + { # An option in a Dropdown. + "displayValue": "A String", # The display value of this dropdown option. + "optionId": "A String", # The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + "title": "A String", # The title of the dropdown definition. + }, + "dropdownDefinitionPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. + "optionsSuggested": True or False, # Indicates if there was a suggested change to options. + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + }, + }, + "suggestedInsertionId": "A String", # ID for suggestion that inserts this dropdown definition. + }, + "tabId": "A String", # The ID of the tab to create the dropdown definition in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, "createFooter": { # Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned. # Creates a footer. "sectionBreakLocation": { # A particular location in the document. # The location of the SectionBreak immediately preceding the section whose SectionStyle this footer should belong to. If this is unset or refers to the first section break in the document, the footer applies to the document style. "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. @@ -197,6 +327,10 @@

Method Details

"tabId": "A String", # The tab that contains this range. When omitted, the request applies to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, + "deleteDropdownDefinition": { # Deletes a DropdownDefinition. If the dropdown definition is referenced by any dropdown instances (chips) in the document, a 400 bad request error is returned. # Deletes a DropdownDefinition. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition to delete. + "tabId": "A String", # The ID of the tab that contains the dropdown definition to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, "deleteFooter": { # Deletes a Footer from the document. # Deletes a footer from the document. "footerId": "A String", # The id of the footer to delete. If this footer is defined on DocumentStyle, the reference to this footer is removed, resulting in no footer of that type for the first section of the document. If this footer is defined on a SectionStyle, the reference to this footer is removed and the footer of that type is now continued from the previous section. "tabId": "A String", # The tab that contains the footer to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. @@ -283,6 +417,19 @@

Method Details

"tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. }, }, + "insertDropdown": { # Inserts a Dropdown at the specified location. # Inserts a Dropdown at the specified location. + "dropdownDefinitionId": "A String", # Required. The DropdownDefinition ID. + "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # The EndOfSegmentLocation in the document to insert the dropdown at. + "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, + "location": { # A particular location in the document. # The Location in the document to insert the dropdown at. + "index": 42, # The zero-based index, in UTF-16 code units. The index is relative to the beginning of the segment specified by segment_id. + "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. + "tabId": "A String", # The tab that the location is in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, + "selectedOptionId": "A String", # Optional initial value for the dropdown. If this field is not specified, the new dropdown will default to selecting the first option defined in the dropdown definition. If this field is specified but does not reference a valid option in the dropdown definition, a 400 bad request error is returned. + }, "insertInlineImage": { # Inserts an InlineObject containing an image at the given location. # Inserts an inline image at the specified location. "endOfSegmentLocation": { # Location at the end of a body, header, footer or footnote. The location is immediately before the last newline in the document segment. # Inserts the text at the end of a header, footer or the document body. Inline images cannot be inserted inside a footnote. "segmentId": "A String", # The ID of the header, footer or footnote the location is in. An empty segment ID signifies the document's body. @@ -560,6 +707,81 @@

Method Details

"title": "A String", # The user-visible name of the tab. }, }, + "updateDropdownDefinitionProperties": { # Updates the properties of a DropdownDefinition. # Updates the properties of a DropdownDefinition. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition to update. + "dropdownDefinitionProperties": { # Properties of a dropdown definition. # The properties to update. + "options": [ # The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. + { # An option in a Dropdown. + "displayValue": "A String", # The display value of this dropdown option. + "optionId": "A String", # The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + "title": "A String", # The title of the dropdown definition. + }, + "fields": "A String", # The fields that should be updated. At least one field must be specified. The root `dropdown_definition_properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. When `dropdown_definition_properties.options` is included in the field mask, the full, complete list of desired options must be provided in `dropdown_definition_properties.options`. + "selectedOptionIdReplacements": { # A map of option IDs to their replacements, used to automatically reassign orphaned Dropdown chips when an option is deleted. The keys are the IDs of the options being deleted, and the values are the IDs of their replacement options. If an option being deleted is selected in one or more Dropdown chips in the document, a replacement entry for that option must be provided in this map, and the replacement option ID must exist in the updated DropdownDefinition. If a replacement is required but not provided, a 400 bad request error is returned. Options being deleted that are not selected in any Dropdown chips do not require a replacement. For example, if option A is being replaced by option B, the map should be `{"A": "B"}`. + "a_key": "A String", + }, + "tabId": "A String", # The ID of the tab that contains the dropdown definition to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, + "updateDropdownProperties": { # Updates the properties of a Dropdown. # Updates the properties of a Dropdown. + "dropdownId": "A String", # Required. The Dropdown ID. + "dropdownProperties": { # Properties specific to a dropdown. # The properties to update. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "fields": "A String", # The fields that should be updated. At least one field must be specified. The root `dropdown_properties` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. + "tabId": "A String", # The ID of the tab that contains the dropdown to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document. + }, "updateNamedStyle": { # Updates a named style. # Updates a named style. "fields": "A String", # The NamedStyle fields that should be updated. At least `named_style_type` must be specified. The root `named_style` is implied and should not be specified. A single `"*"` can be used as short-hand for listing every field. For example, to update the text style to bold, set `fields` to include `"text_style"` and `"text_style.bold"`. To update the paragraph style's alignment property, set `fields` to include `"paragraph_style"` and `"paragraph_style.alignment"`. To reset a property to its default value, include its field name in the field mask but leave the field itself unset. Specifying `"text_style"` or `"paragraph_style"` with an empty TextStyle or ParagraphStyle will reset all of its nested fields. "namedStyle": { # A named style. Paragraphs in the document can inherit their TextStyle and ParagraphStyle from this named style when they have the same named style type. # The document style to update. @@ -1250,6 +1472,135 @@

Method Details

"title": "A String", # The user-visible name of the tab. }, }, + "createDropdownDefinition": { # Response message for creating a dropdown definition. # The result of creating a dropdown definition. + "dropdownDefinition": { # A dropdown definition in the document. # The newly-created DropdownDefinition. + "dropdownDefinitionId": "A String", # The ID of this dropdown definition. If you specify an ID, it must be unique among all IDs in the tab. The ID must start with `kix.` and match regex `^kix\.[a-zA-Z0-9_-]{2,14}$` (length 6-18 chars). If you don't specify an ID, a unique one is generated. + "dropdownDefinitionProperties": { # Properties of a dropdown definition. # The properties of this dropdown definition. + "options": [ # The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. + { # An option in a Dropdown. + "displayValue": "A String", # The display value of this dropdown option. + "optionId": "A String", # The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + "title": "A String", # The title of the dropdown definition. + }, + "suggestedDeletionId": "A String", # ID for suggestion that deletes this dropdown definition. + "suggestedDropdownDefinitionPropertiesChanges": { # Suggested property changes to this definition, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown definition properties. + "dropdownDefinitionProperties": { # Properties of a dropdown definition. # A DropdownDefinitionProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_definition_properties_suggestion_state to see which fields have changed and their new values. + "options": [ # The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. + { # An option in a Dropdown. + "displayValue": "A String", # The display value of this dropdown option. + "optionId": "A String", # The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + "title": "A String", # The title of the dropdown definition. + }, + "dropdownDefinitionPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. + "optionsSuggested": True or False, # Indicates if there was a suggested change to options. + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + }, + }, + "suggestedInsertionId": "A String", # ID for suggestion that inserts this dropdown definition. + }, + }, "createFooter": { # The result of creating a footer. # The result of creating a footer. "footerId": "A String", # The ID of the created footer. }, @@ -1312,6 +1663,147 @@

Method Details

"status": "A String", # Whether the thread is open or resolved. }, }, + "insertDropdown": { # The result of inserting a Dropdown. # The result of inserting a dropdown. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # The newly-inserted Dropdown. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + }, "insertInlineImage": { # The result of inserting an inline image. # The result of inserting an inline image. "objectId": "A String", # The ID of the created InlineObject. }, @@ -1815,25 +2307,32 @@

Method Details

}, }, }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -1898,7 +2397,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -1947,136 +2446,25 @@

Method Details

}, }, }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -2141,7 +2529,250 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -4021,25 +4652,164 @@

Method Details

}, }, }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -6116,146 +6886,285 @@

Method Details

}, }, }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -8211,25 +9120,164 @@

Method Details

}, }, }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -11535,146 +12583,32 @@

Method Details

}, }, }, - "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. - "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - }, - "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. - "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. - "footnoteNumber": "A String", # The rendered number of this footnote. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. - }, - }, - }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - }, - "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. - "A String", - ], - "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -11739,7 +12673,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -11788,15 +12722,25 @@

Method Details

}, }, }, - "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. - "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. + "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. An Equation may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. + }, + "footnoteReference": { # A ParagraphElement representing a footnote reference. A footnote reference is the inline content rendered with a number and is used to identify the footnote. # A footnote reference paragraph element. + "footnoteId": "A String", # The ID of the footnote that contains the content of this footnote reference. + "footnoteNumber": "A String", # The rendered number of this footnote. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A FootnoteReference may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this FootnoteReference, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -11861,7 +12805,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this FootnoteReference. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -11910,14 +12854,14 @@

Method Details

}, }, }, - "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "horizontalRule": { # A ParagraphElement representing a horizontal line. # A horizontal rule paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A HorizontalRule may have multiple insertion IDs if it is a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this HorizontalRule, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -11982,7 +12926,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this HorizontalRule. Similar to text content, like text runs and footnote references, the text style of a horizontal rule can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -12031,19 +12975,15 @@

Method Details

}, }, }, - "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. - "personId": "A String", # Output only. The unique ID of this link. - "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. - "email": "A String", # The email address linked to this Person. This field is always present. - "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "inlineObjectElement": { # A ParagraphElement that contains an InlineObject. # An inline object paragraph element. + "inlineObjectId": "A String", # The ID of the InlineObject this element contains. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. An InlineObjectElement may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this InlineObject, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -12108,7 +13048,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this InlineObjectElement. Similar to text content, like text runs and footnote references, the text style of an inline object element can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -12157,20 +13097,14 @@

Method Details

}, }, }, - "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) - "richLinkId": "A String", # Output only. The ID of this link. - "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. - "mimeType": "A String", # The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). - "title": "A String", # The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. - "uri": "A String", # The URI to the RichLink. This is always present. - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "pageBreak": { # A ParagraphElement representing a page break. A page break makes the subsequent text start at the top of the next page. # A page break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. "A String", ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "suggestedInsertionIds": [ # The suggested insertion IDs. A PageBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this PageBreak, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -12235,7 +13169,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this PageBreak. Similar to text content, like text runs and footnote references, the text style of a page break can affect content layout as well as the styling of text inserted next to it. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -12284,16 +13218,19 @@

Method Details

}, }, }, - "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. - "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. - "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "person": { # A person or email address mentioned in a document. These mentions behave as a single, immutable element containing the person's name or email address. # A paragraph element that links to a person or email address. + "personId": "A String", # Output only. The unique ID of this link. + "personProperties": { # Properties specific to a linked Person. # Output only. The properties of this Person. This field is always present. + "email": "A String", # The email address linked to this Person. This field is always present. + "name": "A String", # The name of the person if it's displayed in the link text instead of the person's email address. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this person link from the document. A Person might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. "A String", ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "suggestedInsertionIds": [ # IDs for suggestions that insert this person link into the document. A Person might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this Person, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -12358,7 +13295,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this Person. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -12407,169 +13344,419 @@

Method Details

}, }, }, - }, - ], - "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. - "alignment": "A String", # The text alignment for this paragraph. - "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. - "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. - "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, + "richLink": { # A link to a Google resource (such as a file in Drive, a YouTube video, or a Calendar event). # A paragraph element that links to a Google resource (such as a file in Google Drive, a YouTube video, or a Calendar event.) + "richLinkId": "A String", # Output only. The ID of this link. + "richLinkProperties": { # Properties specific to a RichLink. # Output only. The properties of this RichLink. This field is always present. + "mimeType": "A String", # The [MIME type](https://developers.google.com/drive/api/v3/mime-types) of the RichLink, if there's one (for example, when it's a file in Drive). + "title": "A String", # The title of the RichLink as displayed in the link. This title matches the title of the linked resource at the time of the insertion or last update of the link. This field is always present. + "uri": "A String", # The URI to the RichLink. This is always present. }, - }, - "dashStyle": "A String", # The dash style of the border. - "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "width": { # A magnitude in a single direction in the specified units. # The width of the border. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. - "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. - "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. - "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. - "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. - "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. - "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. - "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. + "suggestedDeletionIds": [ # IDs for suggestions that remove this link from the document. A RichLink might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this person link isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this link into the document. A RichLink might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this person link isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this RichLink, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, }, }, - }, - }, - "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "spacingMode": "A String", # The spacing mode for the paragraph. - "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. - { # A tab stop within a paragraph. - "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. - "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - }, - ], - }, - "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. - "A String", - ], - "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. - "a_key": { # A suggested change to a Bullet. - "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. - "listId": "A String", # The ID of the list this paragraph belongs to. - "nestingLevel": 42, # The nesting level of this paragraph in the list. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this RichLink. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "startIndex": 42, # The zero-based start index of this paragraph element, in UTF-16 code units. + "textRun": { # A ParagraphElement that represents a run of text that all has the same styling. # A text run paragraph element. + "content": "A String", # The text of this run. Any non-text elements in the run are replaced with the Unicode character U+E907. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A TextRun may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this run, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this run. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + }, + ], + "paragraphStyle": { # Styles that apply to a whole paragraph. Inherited paragraph styles are represented as unset fields in this message. A paragraph style's parent depends on where the paragraph style is defined: * The ParagraphStyle on a Paragraph inherits from the paragraph's corresponding named style type. * The ParagraphStyle on a named style inherits from the normal text named style. * The ParagraphStyle of the normal text named style inherits from the default paragraph style in the Docs editor. * The ParagraphStyle on a Paragraph element that's contained in a table may inherit its paragraph style from the table style. If the paragraph style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The style of this paragraph. + "alignment": "A String", # The text alignment for this paragraph. + "avoidWidowAndOrphan": True or False, # Whether to avoid widows and orphans for the paragraph. If unset, the value is inherited from the parent. + "borderBetween": { # A border around a paragraph. # The border between this paragraph and the next and previous paragraphs. If unset, the value is inherited from the parent. The between border is rendered when the adjacent paragraph has the same border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderBottom": { # A border around a paragraph. # The border at the bottom of this paragraph. If unset, the value is inherited from the parent. The bottom border is rendered when the paragraph below has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderLeft": { # A border around a paragraph. # The border to the left of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderRight": { # A border around a paragraph. # The border to the right of this paragraph. If unset, the value is inherited from the parent. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "borderTop": { # A border around a paragraph. # The border at the top of this paragraph. If unset, the value is inherited from the parent. The top border is rendered when the paragraph above has different border and indent properties. Paragraph borders cannot be partially updated. When changing a paragraph border, the new border must be specified in its entirety. + "color": { # A color that can either be fully opaque or fully transparent. # The color of the border. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "dashStyle": "A String", # The dash style of the border. + "padding": { # A magnitude in a single direction in the specified units. # The padding of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "width": { # A magnitude in a single direction in the specified units. # The width of the border. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + "direction": "A String", # The text direction of this paragraph. If unset, the value defaults to LEFT_TO_RIGHT since paragraph direction is not inherited. + "headingId": "A String", # The heading ID of the paragraph. If empty, then this paragraph is not a heading. This property is read-only. + "indentEnd": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the end of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentFirstLine": { # A magnitude in a single direction in the specified units. # The amount of indentation for the first line of the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "indentStart": { # A magnitude in a single direction in the specified units. # The amount of indentation for the paragraph on the side that corresponds to the start of the text, based on the current paragraph direction. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "keepLinesTogether": True or False, # Whether all lines of the paragraph should be laid out on the same page or column if possible. If unset, the value is inherited from the parent. + "keepWithNext": True or False, # Whether at least a part of this paragraph should be laid out on the same page or column as the next paragraph if possible. If unset, the value is inherited from the parent. + "lineSpacing": 3.14, # The amount of space between lines, as a percentage of normal, where normal is represented as 100.0. If unset, the value is inherited from the parent. + "namedStyleType": "A String", # The named style type of the paragraph. Since updating the named style type affects other properties within ParagraphStyle, the named style type is applied before the other properties are updated. + "pageBreakBefore": True or False, # Whether the current paragraph should always start at the beginning of a page. If unset, the value is inherited from the parent. Attempting to update page_break_before for paragraphs in unsupported regions, including Table, Header, Footer and Footnote, can result in an invalid document state that returns a 400 bad request error. + "shading": { # The shading of a paragraph. # The shading of the paragraph. If unset, the value is inherited from the parent. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of this paragraph shading. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + }, + "spaceAbove": { # A magnitude in a single direction in the specified units. # The amount of extra space above the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spaceBelow": { # A magnitude in a single direction in the specified units. # The amount of extra space below the paragraph. If unset, the value is inherited from the parent. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "spacingMode": "A String", # The spacing mode for the paragraph. + "tabStops": [ # A list of the tab stops for this paragraph. The list of tab stops is not inherited. This property is read-only. + { # A tab stop within a paragraph. + "alignment": "A String", # The alignment of this tab stop. If unset, the value defaults to START. + "offset": { # A magnitude in a single direction in the specified units. # The offset between this tab stop and the start margin. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + }, + ], + }, + "positionedObjectIds": [ # The IDs of the positioned objects tethered to this paragraph. + "A String", + ], + "suggestedBulletChanges": { # The suggested changes to this paragraph's bullet. + "a_key": { # A suggested change to a Bullet. + "bullet": { # Describes the bullet of a paragraph. # A Bullet that only includes the changes made in this suggestion. This can be used along with the bullet_suggestion_state to see which fields have changed and their new values. + "listId": "A String", # The ID of the list this paragraph belongs to. + "nestingLevel": 42, # The nesting level of this paragraph in the list. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The paragraph-specific text style applied to this bullet. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -13250,6 +14437,135 @@

Method Details

"useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, + "dropdownDefinitions": { # The dropdown definitions in a document tab, keyed by dropdown definition ID. + "a_key": { # A dropdown definition in the document. + "dropdownDefinitionId": "A String", # The ID of this dropdown definition. If you specify an ID, it must be unique among all IDs in the tab. The ID must start with `kix.` and match regex `^kix\.[a-zA-Z0-9_-]{2,14}$` (length 6-18 chars). If you don't specify an ID, a unique one is generated. + "dropdownDefinitionProperties": { # Properties of a dropdown definition. # The properties of this dropdown definition. + "options": [ # The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. + { # An option in a Dropdown. + "displayValue": "A String", # The display value of this dropdown option. + "optionId": "A String", # The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + "title": "A String", # The title of the dropdown definition. + }, + "suggestedDeletionId": "A String", # ID for suggestion that deletes this dropdown definition. + "suggestedDropdownDefinitionPropertiesChanges": { # Suggested property changes to this definition, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown definition properties. + "dropdownDefinitionProperties": { # Properties of a dropdown definition. # A DropdownDefinitionProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_definition_properties_suggestion_state to see which fields have changed and their new values. + "options": [ # The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. + { # An option in a Dropdown. + "displayValue": "A String", # The display value of this dropdown option. + "optionId": "A String", # The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + "title": "A String", # The title of the dropdown definition. + }, + "dropdownDefinitionPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. + "optionsSuggested": True or False, # Indicates if there was a suggested change to options. + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + }, + }, + "suggestedInsertionId": "A String", # ID for suggestion that inserts this dropdown definition. + }, + }, "footers": { # The footers in the document tab, keyed by footer ID. "a_key": { # A document footer. "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. @@ -13430,165 +14746,304 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "type": "A String", # The type of this auto text. + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. + "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateId": "A String", # Output only. The unique ID of this date. + "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. + "a_key": { # A suggested change to a DateElementProperties. + "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. + "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. + "localeSuggested": True or False, # Indicates if there was a suggested change to locale. + "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. + "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. + "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. + }, + }, + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. - "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateId": "A String", # Output only. The unique ID of this date. - "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. - "a_key": { # A suggested change to a DateElementProperties. - "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. - "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. - "localeSuggested": True or False, # Indicates if there was a suggested change to locale. - "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. - "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. - "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. - }, - }, - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -13653,7 +15108,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -15797,6 +17252,145 @@

Method Details

}, }, }, + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. @@ -17620,165 +19214,304 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "type": "A String", # The type of this auto text. + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. + "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateId": "A String", # Output only. The unique ID of this date. + "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. + "a_key": { # A suggested change to a DateElementProperties. + "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. + "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. + "localeSuggested": True or False, # Indicates if there was a suggested change to locale. + "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. + "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. + "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. + }, + }, + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. - "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateId": "A String", # Output only. The unique ID of this date. - "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. - "a_key": { # A suggested change to a DateElementProperties. - "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. - "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. - "localeSuggested": True or False, # Indicates if there was a suggested change to locale. - "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. - "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. - "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. - }, - }, - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -17843,7 +19576,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -21181,6 +22914,145 @@

Method Details

}, }, }, + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. @@ -23115,165 +24987,304 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "type": "A String", # The type of this auto text. + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. + "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateId": "A String", # Output only. The unique ID of this date. + "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. + "a_key": { # A suggested change to a DateElementProperties. + "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. + "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. + "localeSuggested": True or False, # Indicates if there was a suggested change to locale. + "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. + "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. + "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. + }, + }, + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. - "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateId": "A String", # Output only. The unique ID of this date. - "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. - "a_key": { # A suggested change to a DateElementProperties. - "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. - "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. - "localeSuggested": True or False, # Indicates if there was a suggested change to locale. - "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. - "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. - "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. - }, - }, - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -23338,7 +25349,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -25482,6 +27493,145 @@

Method Details

}, }, }, + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. @@ -27305,165 +29455,304 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "type": "A String", # The type of this auto text. + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. + "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateId": "A String", # Output only. The unique ID of this date. + "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. + "a_key": { # A suggested change to a DateElementProperties. + "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. + "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. + "localeSuggested": True or False, # Indicates if there was a suggested change to locale. + "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. + "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. + "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. + }, + }, + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. - "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateId": "A String", # Output only. The unique ID of this date. - "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. - "a_key": { # A suggested change to a DateElementProperties. - "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. - "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. - "localeSuggested": True or False, # Indicates if there was a suggested change to locale. - "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. - "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. - "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. - }, - }, - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -27528,7 +29817,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -30901,6 +33190,145 @@

Method Details

}, }, }, + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. @@ -32616,6 +35044,135 @@

Method Details

"useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, + "dropdownDefinitions": { # The dropdown definitions in a document tab, keyed by dropdown definition ID. + "a_key": { # A dropdown definition in the document. + "dropdownDefinitionId": "A String", # The ID of this dropdown definition. If you specify an ID, it must be unique among all IDs in the tab. The ID must start with `kix.` and match regex `^kix\.[a-zA-Z0-9_-]{2,14}$` (length 6-18 chars). If you don't specify an ID, a unique one is generated. + "dropdownDefinitionProperties": { # Properties of a dropdown definition. # The properties of this dropdown definition. + "options": [ # The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. + { # An option in a Dropdown. + "displayValue": "A String", # The display value of this dropdown option. + "optionId": "A String", # The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + "title": "A String", # The title of the dropdown definition. + }, + "suggestedDeletionId": "A String", # ID for suggestion that deletes this dropdown definition. + "suggestedDropdownDefinitionPropertiesChanges": { # Suggested property changes to this definition, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown definition properties. + "dropdownDefinitionProperties": { # Properties of a dropdown definition. # A DropdownDefinitionProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_definition_properties_suggestion_state to see which fields have changed and their new values. + "options": [ # The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. + { # An option in a Dropdown. + "displayValue": "A String", # The display value of this dropdown option. + "optionId": "A String", # The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + "title": "A String", # The title of the dropdown definition. + }, + "dropdownDefinitionPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. + "optionsSuggested": True or False, # Indicates if there was a suggested change to options. + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + }, + }, + "suggestedInsertionId": "A String", # ID for suggestion that inserts this dropdown definition. + }, + }, "footers": { # The footers in the document tab, keyed by footer ID. "a_key": { # A document footer. "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. @@ -32796,165 +35353,304 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "type": "A String", # The type of this auto text. + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. + "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateId": "A String", # Output only. The unique ID of this date. + "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. + "a_key": { # A suggested change to a DateElementProperties. + "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. + "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. + "localeSuggested": True or False, # Indicates if there was a suggested change to locale. + "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. + "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. + "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. + }, + }, + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. - "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateId": "A String", # Output only. The unique ID of this date. - "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. - "a_key": { # A suggested change to a DateElementProperties. - "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. - "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. - "localeSuggested": True or False, # Indicates if there was a suggested change to locale. - "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. - "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. - "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. - }, - }, - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -33019,7 +35715,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -35163,6 +37859,145 @@

Method Details

}, }, }, + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. @@ -36986,165 +39821,304 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "type": "A String", # The type of this auto text. + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. + "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateId": "A String", # Output only. The unique ID of this date. + "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. + "a_key": { # A suggested change to a DateElementProperties. + "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. + "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. + "localeSuggested": True or False, # Indicates if there was a suggested change to locale. + "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. + "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. + "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. + }, + }, + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. - "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateId": "A String", # Output only. The unique ID of this date. - "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. - "a_key": { # A suggested change to a DateElementProperties. - "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. - "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. - "localeSuggested": True or False, # Indicates if there was a suggested change to locale. - "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. - "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. - "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. - }, - }, - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -37209,7 +40183,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -40567,6 +43541,145 @@

Method Details

}, }, }, + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. @@ -42501,165 +45614,304 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "type": "A String", # The type of this auto text. + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. + "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateId": "A String", # Output only. The unique ID of this date. + "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. + "a_key": { # A suggested change to a DateElementProperties. + "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. + "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. + "localeSuggested": True or False, # Indicates if there was a suggested change to locale. + "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. + "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. + "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. + }, + }, + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. - "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateId": "A String", # Output only. The unique ID of this date. - "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. - "a_key": { # A suggested change to a DateElementProperties. - "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. - "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. - "localeSuggested": True or False, # Indicates if there was a suggested change to locale. - "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. - "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. - "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. - }, - }, - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -42724,7 +45976,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -44868,6 +48120,145 @@

Method Details

}, }, }, + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. @@ -46963,6 +50354,145 @@

Method Details

}, }, }, + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. @@ -50138,42 +53668,181 @@

Method Details

}, }, }, - "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. - "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. + "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateId": "A String", # Output only. The unique ID of this date. + "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. + "a_key": { # A suggested change to a DateElementProperties. + "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. + "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. + "localeSuggested": True or False, # Indicates if there was a suggested change to locale. + "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. + "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. + "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. + }, + }, + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - "dateId": "A String", # Output only. The unique ID of this date. - "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. - "a_key": { # A suggested change to a DateElementProperties. - "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. - "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. - "localeSuggested": True or False, # Indicates if there was a suggested change to locale. - "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. - "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. - "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. }, }, }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -50238,7 +53907,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -52002,6 +55671,135 @@

Method Details

"useEvenPageHeaderFooter": True or False, # Indicates whether to use the even page header / footer IDs for the even pages. If DocumentMode is PAGELESS, this property will not be rendered. "useFirstPageHeaderFooter": True or False, # Indicates whether to use the first page header / footer IDs for the first page. If DocumentMode is PAGELESS, this property will not be rendered. }, + "dropdownDefinitions": { # The dropdown definitions in a document tab, keyed by dropdown definition ID. + "a_key": { # A dropdown definition in the document. + "dropdownDefinitionId": "A String", # The ID of this dropdown definition. If you specify an ID, it must be unique among all IDs in the tab. The ID must start with `kix.` and match regex `^kix\.[a-zA-Z0-9_-]{2,14}$` (length 6-18 chars). If you don't specify an ID, a unique one is generated. + "dropdownDefinitionProperties": { # Properties of a dropdown definition. # The properties of this dropdown definition. + "options": [ # The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. + { # An option in a Dropdown. + "displayValue": "A String", # The display value of this dropdown option. + "optionId": "A String", # The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + "title": "A String", # The title of the dropdown definition. + }, + "suggestedDeletionId": "A String", # ID for suggestion that deletes this dropdown definition. + "suggestedDropdownDefinitionPropertiesChanges": { # Suggested property changes to this definition, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown definition properties. + "dropdownDefinitionProperties": { # Properties of a dropdown definition. # A DropdownDefinitionProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_definition_properties_suggestion_state to see which fields have changed and their new values. + "options": [ # The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options. + { # An option in a Dropdown. + "displayValue": "A String", # The display value of this dropdown option. + "optionId": "A String", # The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + ], + "title": "A String", # The title of the dropdown definition. + }, + "dropdownDefinitionPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. + "optionsSuggested": True or False, # Indicates if there was a suggested change to options. + "titleSuggested": True or False, # Indicates if there was a suggested change to title. + }, + }, + }, + "suggestedInsertionId": "A String", # ID for suggestion that inserts this dropdown definition. + }, + }, "footers": { # The footers in the document tab, keyed by footer ID. "a_key": { # A document footer. "content": [ # The contents of the footer. The indexes for a footer's content begin at zero. @@ -52454,6 +56252,145 @@

Method Details

}, }, }, + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. @@ -54277,165 +58214,304 @@

Method Details

"weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. }, }, - "type": "A String", # The type of this auto text. + "type": "A String", # The type of this auto text. + }, + "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. + "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. + "A String", + ], + "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, + "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. + "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateId": "A String", # Output only. The unique ID of this date. + "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. + "a_key": { # A suggested change to a DateElementProperties. + "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. + "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. + "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. + "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. + "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. + "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. + "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. + }, + "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. + "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. + "localeSuggested": True or False, # Indicates if there was a suggested change to locale. + "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. + "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. + "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. + }, + }, + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. + "A String", + ], + "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, }, - "columnBreak": { # A ParagraphElement representing a column break. A column break makes the subsequent text start at the top of the next column. # A column break paragraph element. - "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. - "A String", - ], - "suggestedInsertionIds": [ # The suggested insertion IDs. A ColumnBreak may have multiple insertion IDs if it's a nested suggested change. If empty, then this is not a suggested insertion. + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this ColumnBreak, keyed by suggestion ID. - "a_key": { # A suggested change to a TextStyle. - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. }, - "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. - "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. - "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. - "boldSuggested": True or False, # Indicates if there was a suggested change to bold. - "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. - "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. - "italicSuggested": True or False, # Indicates if there was a suggested change to italic. - "linkSuggested": True or False, # Indicates if there was a suggested change to link. - "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. - "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. - "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. - "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. }, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this ColumnBreak. Similar to text content, like text runs and footnote references, the text style of a column break can affect content layout as well as the styling of text inserted next to it. - "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. - "bold": True or False, # Whether or not the text is rendered as bold. - "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. - "magnitude": 3.14, # The magnitude. - "unit": "A String", # The units for magnitude. - }, - "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. - "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. - "rgbColor": { # An RGB color. # The RGB color value. - "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. - "green": 3.14, # The green component of the color, from 0.0 to 1.0. - "red": 3.14, # The red component of the color, from 0.0 to 1.0. - }, - }, - }, - "italic": True or False, # Whether or not the text is italicized. - "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. - "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a bookmark in this document. - "tabId": "A String", # The ID of the tab containing this bookmark. - }, - "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. - "id": "A String", # The ID of a heading in this document. - "tabId": "A String", # The ID of the tab containing this heading. - }, - "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. - "tabId": "A String", # The ID of a tab in this document. - "url": "A String", # An external URL. - }, - "smallCaps": True or False, # Whether or not the text is in small capital letters. - "strikethrough": True or False, # Whether or not the text is struck through. - "underline": True or False, # Whether or not the text is underlined. - "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. - "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. - "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. - }, - }, - }, - "dateElement": { # A date instance mentioned in a document. # A paragraph element that represents a date. - "dateElementProperties": { # Properties of a DateElement. # The properties of this DateElement. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateId": "A String", # Output only. The unique ID of this date. - "suggestedDateElementPropertiesChanges": { # The suggested changes to the date element properties, keyed by suggestion ID. - "a_key": { # A suggested change to a DateElementProperties. - "dateElementProperties": { # Properties of a DateElement. # DateElementProperties that only includes the changes made in this suggestion. This can be used along with the date_element_properties_suggestion_state to see which fields have changed and their new values. - "dateFormat": "A String", # Determines how the date part of the DateElement will be displayed in the document. If unset, the default value is DATE_FORMAT_MONTH_DAY_YEAR_ABBREVIATED, indicating the DateElement will be formatted as `MMM d, y` in `en`, or locale specific equivalent. - "displayText": "A String", # Output only. Indicates how the DateElement is displayed in the document. - "locale": "A String", # The language code of the DateElement. For example, `en`. If unset, the default locale is `en`. Limited to the following locales: `af`, `am`, `ar`, `as`, `az`, `be`, `bg`, `bn`, `ca`, `cs`, `da`, `de`, `el`, `en`, `en-CA`, `en-GB`, `es`, `es-419`, `et`, `eu`, `fa`, `fi`, `fil`, `fr`, `fr-CA`, `gl`, `gu`, `hi`, `hr`, `hu`, `hy`, `id`, `is`, `it`, `iw`, `ja`, `ka`, `kk`, `km`, `kn`, `ko`, `lo`, `lt`, `lv`, `mk`, `ml`, `mn`, `mr`, `ms`, `ne`, `nl`, `no`, `or`, `pa`, `pl`, `pt-BR`, `pt-PT`, `ro`, `ru`, `si`, `sk`, `sl`, `sq`, `sr`, `sv`, `sw`, `ta`, `te`, `th`, `tr`, `uk`, `ur`, `uz`, `vi`, `zh-CN`, `zh-HK`, `zh-TW`, `zu`, `cy`, `my`. - "timeFormat": "A String", # Determines how the time part of the DateElement will be displayed in the document. If unset, the default value is TIME_FORMAT_DISABLED, indicating no time should be shown. - "timeZoneId": "A String", # The time zone of the DateElement, as defined by the Unicode Common Locale Data Repository (CLDR) project. For example, `America/New_York`. If unset, the default time zone is `etc/UTC`. - "timestamp": "A String", # The point in time to represent, in seconds and nanoseconds since Unix epoch: January 1, 1970 at midnight UTC. Timestamp is expected to be in UTC. If time_zone_id is set, the timestamp is adjusted according to the time zone. For example, a timestamp of `18000` with a date format of `DATE_FORMAT_ISO8601` and time format of `TIME_FORMAT_HOUR_MINUTE` would be displayed as `1970-01-01 5:00 AM`. A timestamp of `18000` with date format of `DATE_FORMAT_ISO8601`, time format of `TIME_FORMAT_HOUR_MINUTE`, and time zone set to `America/New_York` will instead be `1970-01-01 12:00 AM`. - }, - "dateElementPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DateElementProperties have been changed in this suggestion. - "dateFormatSuggested": True or False, # Indicates if there was a suggested change to date_format. - "localeSuggested": True or False, # Indicates if there was a suggested change to locale. - "timeFormatSuggested": True or False, # Indicates if there was a suggested change to time_format. - "timeZoneIdSuggested": True or False, # Indicates if there was a suggested change to time_zone_id. - "timestampSuggested": True or False, # Indicates if there was a suggested change to timestamp. - }, - }, - }, - "suggestedDeletionIds": [ # IDs for suggestions that remove this date from the document. A DateElement might have multiple deletion IDs if, for example, multiple users suggest deleting it. If empty, then this date isn't suggested for deletion. - "A String", - ], - "suggestedInsertionIds": [ # IDs for suggestions that insert this date into the document. A DateElement might have multiple insertion IDs if it's a nested suggested change (a suggestion within a suggestion made by a different user, for example). If empty, then this date isn't a suggested insertion. + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. "A String", ], - "suggestedTextStyleChanges": { # The suggested text style changes to this DateElement, keyed by suggestion ID. + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. "a_key": { # A suggested change to a TextStyle. "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. @@ -54500,7 +58576,7 @@

Method Details

}, }, }, - "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this DateElement. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. "rgbColor": { # An RGB color. # The RGB color value. @@ -56644,6 +60720,145 @@

Method Details

}, }, }, + "dropdown": { # A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options. # A paragraph element that represents a dropdown menu. + "dropdownId": "A String", # The ID of this dropdown. + "dropdownProperties": { # Properties specific to a dropdown. # The properties of this dropdown. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "suggestedDeletionIds": [ # IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion. + "A String", + ], + "suggestedDropdownPropertiesChanges": { # The suggested properties changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to dropdown properties. + "dropdownProperties": { # Properties specific to a dropdown. # A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values. + "displayValue": "A String", # The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes. + "dropdownDefinitionId": "A String", # The ID of the DropdownDefinition that defines the options for this dropdown. + "selectedOptionId": "A String", # The ID of the selected option in this dropdown. + }, + "dropdownPropertiesSuggestionState": { # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. + "selectedOptionIdSuggested": True or False, # Indicates if there was a suggested change to selected_option_id. + }, + }, + }, + "suggestedInsertionIds": [ # IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion. + "A String", + ], + "suggestedTextStyleChanges": { # The suggested text style changes to this dropdown, keyed by suggestion ID. + "a_key": { # A suggested change to a TextStyle. + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # A TextStyle that only includes the changes made in this suggestion. This can be used along with the text_style_suggestion_state to see which fields have changed and their new values. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + "textStyleSuggestionState": { # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. For any field set to true, there's a new suggested value. # A mask that indicates which of the fields on the base TextStyle have been changed in this suggestion. + "backgroundColorSuggested": True or False, # Indicates if there was a suggested change to background_color. + "baselineOffsetSuggested": True or False, # Indicates if there was a suggested change to baseline_offset. + "boldSuggested": True or False, # Indicates if there was a suggested change to bold. + "fontSizeSuggested": True or False, # Indicates if there was a suggested change to font_size. + "foregroundColorSuggested": True or False, # Indicates if there was a suggested change to foreground_color. + "italicSuggested": True or False, # Indicates if there was a suggested change to italic. + "linkSuggested": True or False, # Indicates if there was a suggested change to link. + "smallCapsSuggested": True or False, # Indicates if there was a suggested change to small_caps. + "strikethroughSuggested": True or False, # Indicates if there was a suggested change to strikethrough. + "underlineSuggested": True or False, # Indicates if there was a suggested change to underline. + "weightedFontFamilySuggested": True or False, # Indicates if there was a suggested change to weighted_font_family. + }, + }, + }, + "textStyle": { # Represents the styling that can be applied to text. Inherited text styles are represented as unset fields in this message. A text style's parent depends on where the text style is defined: * The TextStyle of text in a Paragraph inherits from the paragraph's corresponding named style type. * The TextStyle on a named style inherits from the normal text named style. * The TextStyle of the normal text named style inherits from the default text style in the Docs editor. * The TextStyle on a Paragraph element that's contained in a table may inherit its text style from the table style. If the text style does not inherit from a parent, unsetting fields will revert the style to a value matching the defaults in the Docs editor. # The text style of this dropdown. + "backgroundColor": { # A color that can either be fully opaque or fully transparent. # The background color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "baselineOffset": "A String", # The text's vertical offset from its normal position. Text with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically rendered in a smaller font size, computed based on the `font_size` field. Changes in this field don't affect the `font_size`. + "bold": True or False, # Whether or not the text is rendered as bold. + "fontSize": { # A magnitude in a single direction in the specified units. # The size of the text's font. + "magnitude": 3.14, # The magnitude. + "unit": "A String", # The units for magnitude. + }, + "foregroundColor": { # A color that can either be fully opaque or fully transparent. # The foreground color of the text. If set, the color is either an RGB color or transparent, depending on the `color` field. + "color": { # A solid color. # If set, this will be used as an opaque color. If unset, this represents a transparent color. + "rgbColor": { # An RGB color. # The RGB color value. + "blue": 3.14, # The blue component of the color, from 0.0 to 1.0. + "green": 3.14, # The green component of the color, from 0.0 to 1.0. + "red": 3.14, # The red component of the color, from 0.0 to 1.0. + }, + }, + }, + "italic": True or False, # Whether or not the text is italicized. + "link": { # A reference to another portion of a document or an external URL resource. # The hyperlink destination of the text. If unset, there's no link. Links are not inherited from parent text. Changing the link in an update request causes some other changes to the text style of the range: * When setting a link, the text foreground color will be updated to the default link color and the text will be underlined. If these fields are modified in the same request, those values will be used instead of the link defaults. * Setting a link on a text range that overlaps with an existing link will also update the existing link to point to the new URL. * Links are not settable on newline characters. As a result, setting a link on a text range that crosses a paragraph boundary, such as `"ABC\n123"`, will separate the newline character(s) into their own text runs. The link will be applied separately to the runs before and after the newline. * Removing a link will update the text style of the range to match the style of the preceding text (or the default text styles if the preceding text is another link) unless different styles are being set in the same request. + "bookmark": { # A reference to a bookmark in this document. # A bookmark in this document. In documents containing a single tab, links to bookmarks within the singular tab continue to return Link.bookmarkId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a bookmark in this document. + "tabId": "A String", # The ID of the tab containing this bookmark. + }, + "bookmarkId": "A String", # The ID of a bookmark in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.bookmark for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a bookmark within the singular tab. Otherwise, Link.bookmark is returned. If this field is used in a write request, the bookmark is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "heading": { # A reference to a heading in this document. # A heading in this document. In documents containing a single tab, links to headings within the singular tab continue to return Link.headingId when the includeTabsContent parameter is set to `false` or unset. Otherwise, this field is returned. + "id": "A String", # The ID of a heading in this document. + "tabId": "A String", # The ID of the tab containing this heading. + }, + "headingId": "A String", # The ID of a heading in this document. Legacy field: Instead, set includeTabsContent to `true` and use Link.heading for read and write operations. This field is only returned when includeTabsContent is set to `false` in documents containing a single tab and links to a heading within the singular tab. Otherwise, Link.heading is returned. If this field is used in a write request, the heading is considered to be from the tab ID specified in the request. If a tab ID is not specified in the request, it is considered to be from the first tab in the document. + "tabId": "A String", # The ID of a tab in this document. + "url": "A String", # An external URL. + }, + "smallCaps": True or False, # Whether or not the text is in small capital letters. + "strikethrough": True or False, # Whether or not the text is struck through. + "underline": True or False, # Whether or not the text is underlined. + "weightedFontFamily": { # Represents a font family and weight of text. # The font family and rendered weight of the text. If an update request specifies values for both `weighted_font_family` and `bold`, the `weighted_font_family` is applied first, then `bold`. If `weighted_font_family#weight` is not set, it defaults to `400`. If `weighted_font_family` is set, then `weighted_font_family#font_family` must also be set with a non-empty value. Otherwise, a 400 bad request error is returned. + "fontFamily": "A String", # The font family of the text. The font family can be any font from the Font menu in Docs or from [Google Fonts] (https://fonts.google.com/). If the font name is unrecognized, the text is rendered in `Arial`. + "weight": 42, # The weight of the font. This field can have any value that's a multiple of `100` between `100` and `900`, inclusive. This range corresponds to the numerical values described in the CSS 2.1 Specification, [section 15.6](https://www.w3.org/TR/CSS21/fonts.html#font-boldness), with non-numerical values disallowed. The default value is `400` ("normal"). The font weight makes up just one component of the rendered font weight. A combination of the `weight` and the text style's resolved `bold` value determine the rendered weight, after accounting for inheritance: * If the text is bold and the weight is less than `400`, the rendered weight is 400. * If the text is bold and the weight is greater than or equal to `400` but is less than `700`, the rendered weight is `700`. * If the weight is greater than or equal to `700`, the rendered weight is equal to the weight. * If the text is not bold, the rendered weight is equal to the weight. + }, + }, + }, "endIndex": 42, # The zero-base end index of this paragraph element, exclusive, in UTF-16 code units. "equation": { # A ParagraphElement representing an equation. # An equation paragraph element. "suggestedDeletionIds": [ # The suggested deletion IDs. If empty, then there are no suggested deletions of this content. diff --git a/googleapiclient/discovery_cache/documents/docs.v1.json b/googleapiclient/discovery_cache/documents/docs.v1.json index 541e8a5cf5..ca90a805ae 100644 --- a/googleapiclient/discovery_cache/documents/docs.v1.json +++ b/googleapiclient/discovery_cache/documents/docs.v1.json @@ -238,7 +238,7 @@ } } }, -"revision": "20260921", +"revision": "20260928", "rootUrl": "https://docs.googleapis.com/", "schemas": { "AcceptSuggestionRequest": { @@ -608,6 +608,32 @@ }, "type": "object" }, +"CreateDropdownDefinitionRequest": { +"description": "Creates a new DropdownDefinition in the document.", +"id": "CreateDropdownDefinitionRequest", +"properties": { +"dropdownDefinition": { +"$ref": "DropdownDefinition", +"description": "Required. The DropdownDefinition to create." +}, +"tabId": { +"description": "The ID of the tab to create the dropdown definition in. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" +} +}, +"type": "object" +}, +"CreateDropdownDefinitionResponse": { +"description": "Response message for creating a dropdown definition.", +"id": "CreateDropdownDefinitionResponse", +"properties": { +"dropdownDefinition": { +"$ref": "DropdownDefinition", +"description": "The newly-created DropdownDefinition." +} +}, +"type": "object" +}, "CreateFooterRequest": { "description": "Creates a Footer. The new footer is applied to the SectionStyle at the location of the SectionBreak if specified, otherwise it is applied to the DocumentStyle. If a footer of the specified type already exists, a 400 bad request error is returned.", "id": "CreateFooterRequest", @@ -1014,6 +1040,21 @@ }, "type": "object" }, +"DeleteDropdownDefinitionRequest": { +"description": "Deletes a DropdownDefinition. If the dropdown definition is referenced by any dropdown instances (chips) in the document, a 400 bad request error is returned.", +"id": "DeleteDropdownDefinitionRequest", +"properties": { +"dropdownDefinitionId": { +"description": "The ID of the DropdownDefinition to delete.", +"type": "string" +}, +"tabId": { +"description": "The ID of the tab that contains the dropdown definition to delete. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" +} +}, +"type": "object" +}, "DeleteFooterRequest": { "description": "Deletes a Footer from the document.", "id": "DeleteFooterRequest", @@ -1515,6 +1556,13 @@ "$ref": "DocumentStyle", "description": "The style of the document tab." }, +"dropdownDefinitions": { +"additionalProperties": { +"$ref": "DropdownDefinition" +}, +"description": "The dropdown definitions in a document tab, keyed by dropdown definition ID.", +"type": "object" +}, "footers": { "additionalProperties": { "$ref": "Footer" @@ -1585,6 +1633,165 @@ }, "type": "object" }, +"Dropdown": { +"description": "A dropdown in the document. The chip is displayed as a dropdown menu that allows users to select an option from a configurable list of options.", +"id": "Dropdown", +"properties": { +"dropdownId": { +"description": "The ID of this dropdown.", +"type": "string" +}, +"dropdownProperties": { +"$ref": "DropdownProperties", +"description": "The properties of this dropdown." +}, +"suggestedDeletionIds": { +"description": "IDs for suggestions that remove this dropdown from the document. If empty, then this dropdown isn't suggested for deletion.", +"items": { +"type": "string" +}, +"type": "array" +}, +"suggestedDropdownPropertiesChanges": { +"additionalProperties": { +"$ref": "SuggestedDropdownProperties" +}, +"description": "The suggested properties changes to this dropdown, keyed by suggestion ID.", +"type": "object" +}, +"suggestedInsertionIds": { +"description": "IDs for suggestions that insert this dropdown into the document. If empty, then this dropdown isn't a suggested insertion.", +"items": { +"type": "string" +}, +"type": "array" +}, +"suggestedTextStyleChanges": { +"additionalProperties": { +"$ref": "SuggestedTextStyle" +}, +"description": "The suggested text style changes to this dropdown, keyed by suggestion ID.", +"type": "object" +}, +"textStyle": { +"$ref": "TextStyle", +"description": "The text style of this dropdown." +} +}, +"type": "object" +}, +"DropdownDefinition": { +"description": "A dropdown definition in the document.", +"id": "DropdownDefinition", +"properties": { +"dropdownDefinitionId": { +"description": "The ID of this dropdown definition. If you specify an ID, it must be unique among all IDs in the tab. The ID must start with `kix.` and match regex `^kix\\.[a-zA-Z0-9_-]{2,14}$` (length 6-18 chars). If you don't specify an ID, a unique one is generated.", +"type": "string" +}, +"dropdownDefinitionProperties": { +"$ref": "DropdownDefinitionProperties", +"description": "The properties of this dropdown definition." +}, +"suggestedDeletionId": { +"description": "ID for suggestion that deletes this dropdown definition.", +"type": "string" +}, +"suggestedDropdownDefinitionPropertiesChanges": { +"additionalProperties": { +"$ref": "SuggestedDropdownDefinitionProperties" +}, +"description": "Suggested property changes to this definition, keyed by suggestion ID.", +"type": "object" +}, +"suggestedInsertionId": { +"description": "ID for suggestion that inserts this dropdown definition.", +"type": "string" +} +}, +"type": "object" +}, +"DropdownDefinitionProperties": { +"description": "Properties of a dropdown definition.", +"id": "DropdownDefinitionProperties", +"properties": { +"options": { +"description": "The list of options defined by this dropdown definition. A dropdown definition must have at least 2 options and at most 50 options.", +"items": { +"$ref": "DropdownOption" +}, +"type": "array" +}, +"title": { +"description": "The title of the dropdown definition.", +"type": "string" +} +}, +"type": "object" +}, +"DropdownDefinitionPropertiesSuggestionState": { +"description": "A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.", +"id": "DropdownDefinitionPropertiesSuggestionState", +"properties": { +"optionsSuggested": { +"description": "Indicates if there was a suggested change to options.", +"type": "boolean" +}, +"titleSuggested": { +"description": "Indicates if there was a suggested change to title.", +"type": "boolean" +} +}, +"type": "object" +}, +"DropdownOption": { +"description": "An option in a Dropdown.", +"id": "DropdownOption", +"properties": { +"displayValue": { +"description": "The display value of this dropdown option.", +"type": "string" +}, +"optionId": { +"description": "The ID of this dropdown option. If you specify an ID, it must be unique among all options in this dropdown definition. The ID must start with `dropdownItem.` and match regex `^dropdownItem\\.[a-zA-Z0-9_-]{2,14}$` (length 15-27 chars). If you don't specify an ID, a unique one is generated.", +"type": "string" +}, +"textStyle": { +"$ref": "TextStyle", +"description": "The text style of this dropdown option. Currently, only the `foreground_color` and `background_color` properties are supported. If other properties are set, a 400 bad request error is returned." +} +}, +"type": "object" +}, +"DropdownProperties": { +"description": "Properties specific to a dropdown.", +"id": "DropdownProperties", +"properties": { +"displayValue": { +"description": "The human-readable display text of the currently selected item. This field is populated by the server based on the dropdown definition and the selected option ID. It may differ from `DropdownOption.display_value` if the underlying option definition was modified or deleted, or during pending suggested changes.", +"type": "string" +}, +"dropdownDefinitionId": { +"description": "The ID of the DropdownDefinition that defines the options for this dropdown.", +"type": "string" +}, +"selectedOptionId": { +"description": "The ID of the selected option in this dropdown.", +"type": "string" +} +}, +"type": "object" +}, +"DropdownPropertiesSuggestionState": { +"description": "A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion. For any field set to true, there's a new suggested value.", +"id": "DropdownPropertiesSuggestionState", +"properties": { +"selectedOptionIdSuggested": { +"description": "Indicates if there was a suggested change to selected_option_id.", +"type": "boolean" +} +}, +"type": "object" +}, "EmbeddedDrawingProperties": { "description": "The properties of an embedded drawing and used to differentiate the object type. An embedded drawing is one that's created and edited within a document. Note that extensive details are not supported.", "id": "EmbeddedDrawingProperties", @@ -2156,6 +2363,40 @@ }, "type": "object" }, +"InsertDropdownRequest": { +"description": "Inserts a Dropdown at the specified location.", +"id": "InsertDropdownRequest", +"properties": { +"dropdownDefinitionId": { +"description": "Required. The DropdownDefinition ID.", +"type": "string" +}, +"endOfSegmentLocation": { +"$ref": "EndOfSegmentLocation", +"description": "The EndOfSegmentLocation in the document to insert the dropdown at." +}, +"location": { +"$ref": "Location", +"description": "The Location in the document to insert the dropdown at." +}, +"selectedOptionId": { +"description": "Optional initial value for the dropdown. If this field is not specified, the new dropdown will default to selecting the first option defined in the dropdown definition. If this field is specified but does not reference a valid option in the dropdown definition, a 400 bad request error is returned.", +"type": "string" +} +}, +"type": "object" +}, +"InsertDropdownResponse": { +"description": "The result of inserting a Dropdown.", +"id": "InsertDropdownResponse", +"properties": { +"dropdown": { +"$ref": "Dropdown", +"description": "The newly-inserted Dropdown." +} +}, +"type": "object" +}, "InsertInlineImageRequest": { "description": "Inserts an InlineObject containing an image at the given location.", "id": "InsertInlineImageRequest", @@ -2921,6 +3162,10 @@ "$ref": "DateElement", "description": "A paragraph element that represents a date." }, +"dropdown": { +"$ref": "Dropdown", +"description": "A paragraph element that represents a dropdown menu." +}, "endIndex": { "description": "The zero-base end index of this paragraph element, exclusive, in UTF-16 code units.", "format": "int32", @@ -3651,6 +3896,10 @@ "$ref": "AddDocumentTabRequest", "description": "Adds a document tab." }, +"createDropdownDefinition": { +"$ref": "CreateDropdownDefinitionRequest", +"description": "Creates a DropdownDefinition." +}, "createFooter": { "$ref": "CreateFooterRequest", "description": "Creates a footer." @@ -3683,6 +3932,10 @@ "$ref": "DeleteContentRangeRequest", "description": "Deletes content from the document." }, +"deleteDropdownDefinition": { +"$ref": "DeleteDropdownDefinitionRequest", +"description": "Deletes a DropdownDefinition." +}, "deleteFooter": { "$ref": "DeleteFooterRequest", "description": "Deletes a footer from the document." @@ -3727,6 +3980,10 @@ "$ref": "InsertDateRequest", "description": "Inserts a date." }, +"insertDropdown": { +"$ref": "InsertDropdownRequest", +"description": "Inserts a Dropdown at the specified location." +}, "insertInlineImage": { "$ref": "InsertInlineImageRequest", "description": "Inserts an inline image at the specified location." @@ -3803,6 +4060,14 @@ "$ref": "UpdateDocumentTabPropertiesRequest", "description": "Updates the properties of a document tab." }, +"updateDropdownDefinitionProperties": { +"$ref": "UpdateDropdownDefinitionPropertiesRequest", +"description": "Updates the properties of a DropdownDefinition." +}, +"updateDropdownProperties": { +"$ref": "UpdateDropdownPropertiesRequest", +"description": "Updates the properties of a Dropdown." +}, "updateNamedStyle": { "$ref": "UpdateNamedStyleRequest", "description": "Updates a named style." @@ -3846,6 +4111,10 @@ "$ref": "AddDocumentTabResponse", "description": "The result of adding a document tab." }, +"createDropdownDefinition": { +"$ref": "CreateDropdownDefinitionResponse", +"description": "The result of creating a dropdown definition." +}, "createFooter": { "$ref": "CreateFooterResponse", "description": "The result of creating a footer." @@ -3866,6 +4135,10 @@ "$ref": "InsertCommentResponse", "description": "The result of inserting a comment. [Developer Preview](https://developers.google.com/workspace/preview)." }, +"insertDropdown": { +"$ref": "InsertDropdownResponse", +"description": "The result of inserting a dropdown." +}, "insertInlineImage": { "$ref": "InsertInlineImageResponse", "description": "The result of inserting an inline image." @@ -4301,6 +4574,36 @@ }, "type": "object" }, +"SuggestedDropdownDefinitionProperties": { +"description": "A suggested change to dropdown definition properties.", +"id": "SuggestedDropdownDefinitionProperties", +"properties": { +"dropdownDefinitionProperties": { +"$ref": "DropdownDefinitionProperties", +"description": "A DropdownDefinitionProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_definition_properties_suggestion_state to see which fields have changed and their new values." +}, +"dropdownDefinitionPropertiesSuggestionState": { +"$ref": "DropdownDefinitionPropertiesSuggestionState", +"description": "A mask that indicates which of the fields on the base DropdownDefinitionProperties have been changed in this suggestion." +} +}, +"type": "object" +}, +"SuggestedDropdownProperties": { +"description": "A suggested change to dropdown properties.", +"id": "SuggestedDropdownProperties", +"properties": { +"dropdownProperties": { +"$ref": "DropdownProperties", +"description": "A DropdownProperties that only includes the changes made in this suggestion. This can be used along with the dropdown_properties_suggestion_state to see which fields have changed and their new values." +}, +"dropdownPropertiesSuggestionState": { +"$ref": "DropdownPropertiesSuggestionState", +"description": "A mask that indicates which of the fields on the base DropdownProperties have been changed in this suggestion." +} +}, +"type": "object" +}, "SuggestedInlineObjectProperties": { "description": "A suggested change to InlineObjectProperties.", "id": "SuggestedInlineObjectProperties", @@ -5261,6 +5564,61 @@ }, "type": "object" }, +"UpdateDropdownDefinitionPropertiesRequest": { +"description": "Updates the properties of a DropdownDefinition.", +"id": "UpdateDropdownDefinitionPropertiesRequest", +"properties": { +"dropdownDefinitionId": { +"description": "The ID of the DropdownDefinition to update.", +"type": "string" +}, +"dropdownDefinitionProperties": { +"$ref": "DropdownDefinitionProperties", +"description": "The properties to update." +}, +"fields": { +"description": "The fields that should be updated. At least one field must be specified. The root `dropdown_definition_properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field. When `dropdown_definition_properties.options` is included in the field mask, the full, complete list of desired options must be provided in `dropdown_definition_properties.options`.", +"format": "google-fieldmask", +"type": "string" +}, +"selectedOptionIdReplacements": { +"additionalProperties": { +"type": "string" +}, +"description": "A map of option IDs to their replacements, used to automatically reassign orphaned Dropdown chips when an option is deleted. The keys are the IDs of the options being deleted, and the values are the IDs of their replacement options. If an option being deleted is selected in one or more Dropdown chips in the document, a replacement entry for that option must be provided in this map, and the replacement option ID must exist in the updated DropdownDefinition. If a replacement is required but not provided, a 400 bad request error is returned. Options being deleted that are not selected in any Dropdown chips do not require a replacement. For example, if option A is being replaced by option B, the map should be `{\"A\": \"B\"}`.", +"type": "object" +}, +"tabId": { +"description": "The ID of the tab that contains the dropdown definition to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" +} +}, +"type": "object" +}, +"UpdateDropdownPropertiesRequest": { +"description": "Updates the properties of a Dropdown.", +"id": "UpdateDropdownPropertiesRequest", +"properties": { +"dropdownId": { +"description": "Required. The Dropdown ID.", +"type": "string" +}, +"dropdownProperties": { +"$ref": "DropdownProperties", +"description": "The properties to update." +}, +"fields": { +"description": "The fields that should be updated. At least one field must be specified. The root `dropdown_properties` is implied and should not be specified. A single `\"*\"` can be used as short-hand for listing every field.", +"format": "google-fieldmask", +"type": "string" +}, +"tabId": { +"description": "The ID of the tab that contains the dropdown to update. When omitted, the request is applied to the first tab. In a document containing a single tab: - If provided, must match the singular tab's ID. - If omitted, the request applies to the singular tab. In a document containing multiple tabs: - If provided, the request applies to the specified tab. - If omitted, the request applies to the first tab in the document.", +"type": "string" +} +}, +"type": "object" +}, "UpdateNamedStyleRequest": { "description": "Updates a named style.", "id": "UpdateNamedStyleRequest", From a3f08ea0bf3756df0d248c1855c7d89b5fea12cd Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:37 +0000 Subject: [PATCH 20/41] feat(firebasecrashlytics): update the api #### firebasecrashlytics:v1alpha The following keys were added: - resources.projects.resources.apps.resources.reports.methods.get.parameters.metricsMode (Total Keys: 2) --- ...shlytics_v1alpha.projects.apps.events.html | 2 +- ...hlytics_v1alpha.projects.apps.reports.html | 9 +++++++-- .../firebasecrashlytics.v1alpha.json | 19 +++++++++++++++++-- 3 files changed, 25 insertions(+), 5 deletions(-) diff --git a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.events.html b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.events.html index 616c3db384..eff51580ac 100644 --- a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.events.html +++ b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.events.html @@ -319,7 +319,7 @@

Method Details

Args: parent: string, Required. The Firebase application. Format: "projects/{project}/apps/{app_id}". (required) - filterExpression: string, Optional. Filters events by custom keys (https://firebase.google.com/docs/crashlytics/customize-crash-reports#add-keys). Supported forms: * Equality: `custom_keys.level = "vip"` or `custom_keys.level:"vip"` * Presence: `custom_keys.level:*` * OR across values of one key: `custom_keys.level = "vip" OR custom_keys.level = "enterprise"` * AND across different keys: `custom_keys.level = "vip" AND custom_keys.region = "us"` Keys are case-sensitive. Keys and values containing spaces must be double-quoted, for example `custom_keys."app state" = "background"`. OR across different keys, repeating a key within an AND, NOT, and comparators other than `=` and `:` are rejected with INVALID_ARGUMENT. Wildcards are not supported in values; use `custom_keys.:*` to match events that set a key to any value. Only supported for Android and iOS. This filter expression applies in addition to the `filter` field above. The syntax is a subset of AIP-160 (https://google.aip.dev/160). + filterExpression: string, Optional. Filters events by custom keys (https://firebase.google.com/docs/crashlytics/customize-crash-reports#add-keys). Supported forms: * Equality: `custom_keys.level = "vip"` or `custom_keys.level:"vip"` * Presence: `custom_keys.level:*` * OR across values of one key: `custom_keys.level = "vip" OR custom_keys.level = "enterprise"` * AND across different keys: `custom_keys.level = "vip" AND custom_keys.region = "us"` Keys are case-sensitive. Keys and values containing spaces must be double-quoted, for example `custom_keys."app state" = "background"`. OR across different keys, repeating a key within an AND, NOT, and comparators other than `=` and `:` are rejected with INVALID_ARGUMENT. Wildcards are not supported in values; use `custom_keys.:*` to match events that set a key to any value. This filter expression applies in addition to the `filter` field above. The syntax is a subset of AIP-160 (https://google.aip.dev/160). filter_browser_displayNames: string, Optional. Only count events from the given browser. This string matches Browser.display_name. Format: "name (display_version)" e.g. "Chrome (123)", or just "name" for all possible versions, e.g. simply "Chrome". (repeated) filter_device_displayNames: string, Only counts events from the given Device model. This string matches Device.display_name. Format: "manufacturer (model)" e.g. "Google (Pixel 6)", or just "manufacturer" for all possible models, e.g. simply "Google". Note that a device's marketing_name field can not be used for filtering. (repeated) filter_device_formFactors: string, Only counts events from devices with the given form factor (e.g. phone or tablet). (repeated) diff --git a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html index 3a4af90be2..0c5ecb2715 100644 --- a/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html +++ b/docs/dyn/firebasecrashlytics_v1alpha.projects.apps.reports.html @@ -78,7 +78,7 @@

Instance Methods

close()

Close httplib2 connections.

- get(name, filter_browser_displayNames=None, filter_device_displayNames=None, filter_device_formFactors=None, filter_interval_endTime=None, filter_interval_startTime=None, filter_issue_content=None, filter_issue_errorTypes=None, filter_issue_id=None, filter_issue_signals=None, filter_issue_state=None, filter_issue_states=None, filter_issue_variantId=None, filter_operatingSystem_displayNames=None, filter_version_displayNames=None, granularity=None, pageSize=None, pageToken=None, x__xgafv=None)

+ get(name, filter_browser_displayNames=None, filter_device_displayNames=None, filter_device_formFactors=None, filter_interval_endTime=None, filter_interval_startTime=None, filter_issue_content=None, filter_issue_errorTypes=None, filter_issue_id=None, filter_issue_signals=None, filter_issue_state=None, filter_issue_states=None, filter_issue_variantId=None, filter_operatingSystem_displayNames=None, filter_version_displayNames=None, granularity=None, metricsMode=None, pageSize=None, pageToken=None, x__xgafv=None)

Get a report with its computed results.

get_next(previous_request, previous_response)

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

Method Details

- get(name, filter_browser_displayNames=None, filter_device_displayNames=None, filter_device_formFactors=None, filter_interval_endTime=None, filter_interval_startTime=None, filter_issue_content=None, filter_issue_errorTypes=None, filter_issue_id=None, filter_issue_signals=None, filter_issue_state=None, filter_issue_states=None, filter_issue_variantId=None, filter_operatingSystem_displayNames=None, filter_version_displayNames=None, granularity=None, pageSize=None, pageToken=None, x__xgafv=None) + get(name, filter_browser_displayNames=None, filter_device_displayNames=None, filter_device_formFactors=None, filter_interval_endTime=None, filter_interval_startTime=None, filter_issue_content=None, filter_issue_errorTypes=None, filter_issue_id=None, filter_issue_signals=None, filter_issue_state=None, filter_issue_states=None, filter_issue_variantId=None, filter_operatingSystem_displayNames=None, filter_version_displayNames=None, granularity=None, metricsMode=None, pageSize=None, pageToken=None, x__xgafv=None)
Get a report with its computed results.
 
 Args:
@@ -146,6 +146,11 @@ 

Method Details

TIME_GRANULARITY_NONE - Returns a single interval for the requested time range. TIME_GRANULARITY_HOUR - Hour. TIME_GRANULARITY_DAY - Day. + metricsMode: string, Optional. Controls whether metrics are raw observed values (mobile and web) or extrapolated values (web only). If omitted, defaults to OBSERVED. + Allowed values + METRICS_MODE_UNSPECIFIED - Unknown. + METRICS_MODE_OBSERVED - Raw counts of the events, sessions, and users that were actually collected. + METRICS_MODE_EXTRAPOLATED - Web only. Estimated event counts based on the per-session sampling rate recorded on each event. pageSize: integer, Optional. The maximum number of result groups to return. If omitted, defaults to 25. pageToken: string, Optional. A page token, received from a previous call. The page token is only valid for the exact same set of filters, which must also be sent in subsequent requests. This token is valid for 10 minutes after the first request. x__xgafv: string, V1 error format. diff --git a/googleapiclient/discovery_cache/documents/firebasecrashlytics.v1alpha.json b/googleapiclient/discovery_cache/documents/firebasecrashlytics.v1alpha.json index 58696ba3d4..30ea76527a 100644 --- a/googleapiclient/discovery_cache/documents/firebasecrashlytics.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/firebasecrashlytics.v1alpha.json @@ -309,7 +309,7 @@ "type": "string" }, "filterExpression": { -"description": "Optional. Filters events by custom keys (https://firebase.google.com/docs/crashlytics/customize-crash-reports#add-keys). Supported forms: * Equality: `custom_keys.level = \"vip\"` or `custom_keys.level:\"vip\"` * Presence: `custom_keys.level:*` * OR across values of one key: `custom_keys.level = \"vip\" OR custom_keys.level = \"enterprise\"` * AND across different keys: `custom_keys.level = \"vip\" AND custom_keys.region = \"us\"` Keys are case-sensitive. Keys and values containing spaces must be double-quoted, for example `custom_keys.\"app state\" = \"background\"`. OR across different keys, repeating a key within an AND, NOT, and comparators other than `=` and `:` are rejected with INVALID_ARGUMENT. Wildcards are not supported in values; use `custom_keys.:*` to match events that set a key to any value. Only supported for Android and iOS. This filter expression applies in addition to the `filter` field above. The syntax is a subset of AIP-160 (https://google.aip.dev/160).", +"description": "Optional. Filters events by custom keys (https://firebase.google.com/docs/crashlytics/customize-crash-reports#add-keys). Supported forms: * Equality: `custom_keys.level = \"vip\"` or `custom_keys.level:\"vip\"` * Presence: `custom_keys.level:*` * OR across values of one key: `custom_keys.level = \"vip\" OR custom_keys.level = \"enterprise\"` * AND across different keys: `custom_keys.level = \"vip\" AND custom_keys.region = \"us\"` Keys are case-sensitive. Keys and values containing spaces must be double-quoted, for example `custom_keys.\"app state\" = \"background\"`. OR across different keys, repeating a key within an AND, NOT, and comparators other than `=` and `:` are rejected with INVALID_ARGUMENT. Wildcards are not supported in values; use `custom_keys.:*` to match events that set a key to any value. This filter expression applies in addition to the `filter` field above. The syntax is a subset of AIP-160 (https://google.aip.dev/160).", "location": "query", "type": "string" }, @@ -716,6 +716,21 @@ "location": "query", "type": "string" }, +"metricsMode": { +"description": "Optional. Controls whether metrics are raw observed values (mobile and web) or extrapolated values (web only). If omitted, defaults to OBSERVED.", +"enum": [ +"METRICS_MODE_UNSPECIFIED", +"METRICS_MODE_OBSERVED", +"METRICS_MODE_EXTRAPOLATED" +], +"enumDescriptions": [ +"Unknown.", +"Raw counts of the events, sessions, and users that were actually collected.", +"Web only. Estimated event counts based on the per-session sampling rate recorded on each event." +], +"location": "query", +"type": "string" +}, "name": { "description": "Required. The report name. Format: \"projects/{project}/apps/{app_id}/reports/{report}\".", "location": "path", @@ -807,7 +822,7 @@ } } }, -"revision": "20260924", +"revision": "20261002", "rootUrl": "https://firebasecrashlytics.googleapis.com/", "schemas": { "BatchGetEventsResponse": { From c848ae59061502fb81c2f8f6d4344d407a284253 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:37 +0000 Subject: [PATCH 21/41] feat(firebasedataconnect): update the api #### firebasedataconnect:v1 The following keys were added: - resources.projects.resources.locations.resources.services.resources.schemas.methods.migrate (Total Keys: 12) - schemas.MigrateSchemaRequest (Total Keys: 6) - schemas.MigrationStep (Total Keys: 5) #### firebasedataconnect:v1beta The following keys were added: - resources.projects.resources.locations.resources.services.resources.schemas.methods.migrate (Total Keys: 12) - schemas.MigrateSchemaRequest (Total Keys: 6) - schemas.MigrationStep (Total Keys: 5) --- ...1.projects.locations.services.schemas.html | 53 ++++++++++++ ...a.projects.locations.services.schemas.html | 53 ++++++++++++ .../documents/firebasedataconnect.v1.json | 83 ++++++++++++++++++- .../documents/firebasedataconnect.v1beta.json | 83 ++++++++++++++++++- 4 files changed, 270 insertions(+), 2 deletions(-) diff --git a/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html b/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html index 503d989830..f2ff9bfb3a 100644 --- a/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html +++ b/docs/dyn/firebasedataconnect_v1.projects.locations.services.schemas.html @@ -92,6 +92,9 @@

Instance Methods

list_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Executes SQL migration steps against the active database schema. This operation compares submitted migration steps against the schema migration ledger (`firebasesql.schema_migrations`), executes unapplied DDL, and records applied steps. It does NOT persist the GraphQL schema to the control plane.

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

Updates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema.

@@ -370,6 +373,56 @@

Method Details

+
+ migrate(name, body=None, x__xgafv=None) +
Executes SQL migration steps against the active database schema. This operation compares submitted migration steps against the schema migration ledger (`firebasesql.schema_migrations`), executes unapplied DDL, and records applied steps. It does NOT persist the GraphQL schema to the control plane.
+
+Args:
+  name: string, Required. Resource name of the target schema: projects/{project}/locations/{location}/services/{service}/schemas/{schema} Note: Only `schemas/main` is supported (singleton schema per service). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `MigrateSchema`. Next tag: 7
+  "executionMode": "A String", # Optional. Execution mode controlling DDL execution and ledger recording. Defaults to EXECUTE_AND_RECORD.
+  "migrationSteps": [ # Required. Ordered migration steps from `./sql/migrations/` (or a single ad-hoc step). Backend compares submitted versions against `firebasesql.schema_migrations`: already-applied steps are verified for SQL immutability and skipped, while unapplied steps (`version > MAX(applied_version)`) are executed. All unapplied transactional steps in a single request execute atomically within one database transaction (BEGIN ... COMMIT): either every unapplied step commits and is recorded in the ledger, or the entire request rolls back. An unapplied step containing CREATE INDEX CONCURRENTLY or DROP INDEX CONCURRENTLY cannot be mixed with other unapplied steps and must be the sole unapplied step executed in the request.
+    { # An individual unit of migration work. Next tag: 4
+      "name": "A String", # Optional. Descriptive migration label (e.g. "create_accounts_table"). If omitted, defaults to "adhoc".
+      "sql": "A String", # Required. Raw multi-statement SQL script. The backend splits it into individual statements before execution; callers do not pre-split. Required whenever the request executes or records DDL, which is every publicly available execution mode; omitting it returns INVALID_ARGUMENT.
+      "version": "A String", # Optional. Monotonic 14-digit UTC timestamp (YYYYMMDDHHMMSS), matching the timestamp prefix of the developer's migration filename. Constrained to `^[0-9]{14}$`. - When specified (file migrations): If `version` is already recorded in `firebasesql.schema_migrations`, the backend verifies that `sql` matches the recorded statements and skips execution. If `version` is unapplied, the backend validates `version > MAX(applied_version)` and records the value unchanged, so the ledger row and the on-disk filename stay identical. - When omitted (Console/ad-hoc): Backend auto-generates a 14-digit UTC timestamp.
+    },
+  ],
+  "validateOnly": True or False, # Optional. When true, runs preflight validation (syntax, applied-step immutability, sequence ordering, CONCURRENTLY isolation, and SAVEPOINT catalog checks) without committing mutations to the database.
+}
+
+  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.
+  },
+}
+
+
patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema.
diff --git a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html
index e517053bda..0295db760d 100644
--- a/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html
+++ b/docs/dyn/firebasedataconnect_v1beta.projects.locations.services.schemas.html
@@ -92,6 +92,9 @@ 

Instance Methods

list_next(previous_request, previous_response)

Retrieves the next page of results.

+

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

+

Executes SQL migration steps against the active database schema. This operation compares submitted migration steps against the schema migration ledger (`firebasesql.schema_migrations`), executes unapplied DDL, and records applied steps. It does NOT persist the GraphQL schema to the control plane.

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

Updates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema.

@@ -370,6 +373,56 @@

Method Details

+
+ migrate(name, body=None, x__xgafv=None) +
Executes SQL migration steps against the active database schema. This operation compares submitted migration steps against the schema migration ledger (`firebasesql.schema_migrations`), executes unapplied DDL, and records applied steps. It does NOT persist the GraphQL schema to the control plane.
+
+Args:
+  name: string, Required. Resource name of the target schema: projects/{project}/locations/{location}/services/{service}/schemas/{schema} Note: Only `schemas/main` is supported (singleton schema per service). (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for `MigrateSchema`. Next tag: 7
+  "executionMode": "A String", # Optional. Execution mode controlling DDL execution and ledger recording. Defaults to EXECUTE_AND_RECORD.
+  "migrationSteps": [ # Required. Ordered migration steps from `./sql/migrations/` (or a single ad-hoc step). Backend compares submitted versions against `firebasesql.schema_migrations`: already-applied steps are verified for SQL immutability and skipped, while unapplied steps (`version > MAX(applied_version)`) are executed. All unapplied transactional steps in a single request execute atomically within one database transaction (BEGIN ... COMMIT): either every unapplied step commits and is recorded in the ledger, or the entire request rolls back. An unapplied step containing CREATE INDEX CONCURRENTLY or DROP INDEX CONCURRENTLY cannot be mixed with other unapplied steps and must be the sole unapplied step executed in the request.
+    { # An individual unit of migration work. Next tag: 4
+      "name": "A String", # Optional. Descriptive migration label (e.g. "create_accounts_table"). If omitted, defaults to "adhoc".
+      "sql": "A String", # Required. Raw multi-statement SQL script. The backend splits it into individual statements before execution; callers do not pre-split. Required whenever the request executes or records DDL, which is every publicly available execution mode; omitting it returns INVALID_ARGUMENT.
+      "version": "A String", # Optional. Monotonic 14-digit UTC timestamp (YYYYMMDDHHMMSS), matching the timestamp prefix of the developer's migration filename. Constrained to `^[0-9]{14}$`. - When specified (file migrations): If `version` is already recorded in `firebasesql.schema_migrations`, the backend verifies that `sql` matches the recorded statements and skips execution. If `version` is unapplied, the backend validates `version > MAX(applied_version)` and records the value unchanged, so the ledger row and the on-disk filename stay identical. - When omitted (Console/ad-hoc): Backend auto-generates a 14-digit UTC timestamp.
+    },
+  ],
+  "validateOnly": True or False, # Optional. When true, runs preflight validation (syntax, applied-step immutability, sequence ordering, CONCURRENTLY isolation, and SAVEPOINT catalog checks) without committing mutations to the database.
+}
+
+  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.
+  },
+}
+
+
patch(name, allowMissing=None, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)
Updates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema.
diff --git a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json
index 768700b136..cf3499c298 100644
--- a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json
+++ b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1.json
@@ -1163,6 +1163,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"migrate": {
+"description": "Executes SQL migration steps against the active database schema. This operation compares submitted migration steps against the schema migration ledger (`firebasesql.schema_migrations`), executes unapplied DDL, and records applied steps. It does NOT persist the GraphQL schema to the control plane.",
+"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}:migrate",
+"httpMethod": "POST",
+"id": "firebasedataconnect.projects.locations.services.schemas.migrate",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Resource name of the target schema: projects/{project}/locations/{location}/services/{service}/schemas/{schema} Note: Only `schemas/main` is supported (singleton schema per service).",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/schemas/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:migrate",
+"request": {
+"$ref": "MigrateSchemaRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "patch": {
 "description": "Updates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema.",
 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}",
@@ -1221,7 +1249,7 @@
 }
 }
 },
-"revision": "20260726",
+"revision": "20260927",
 "rootUrl": "https://firebasedataconnect.googleapis.com/",
 "schemas": {
 "CancelOperationRequest": {
@@ -1999,6 +2027,59 @@
 },
 "type": "object"
 },
+"MigrateSchemaRequest": {
+"description": "Request message for `MigrateSchema`. Next tag: 7",
+"id": "MigrateSchemaRequest",
+"properties": {
+"executionMode": {
+"description": "Optional. Execution mode controlling DDL execution and ledger recording. Defaults to EXECUTE_AND_RECORD.",
+"enum": [
+"EXECUTION_MODE_UNSPECIFIED",
+"EXECUTE_AND_RECORD",
+"EXECUTE_ONLY",
+"RECORD_ONLY"
+],
+"enumDescriptions": [
+"Default behavior. Evaluates to EXECUTE_AND_RECORD.",
+"Standard execution: executes DDL statements against the database catalog and records completed steps in `firebasesql.schema_migrations`.",
+"Applies DDL statements against the database catalog without writing to the ledger. Used for maintenance scripts, temporary schema objects, and the internal declarative flow.",
+"Records steps into `firebasesql.schema_migrations` without executing their DDL statements. Used for baselining pre-existing schemas or manual out-of-band changes (e.g. ledger-only)."
+],
+"type": "string"
+},
+"migrationSteps": {
+"description": "Required. Ordered migration steps from `./sql/migrations/` (or a single ad-hoc step). Backend compares submitted versions against `firebasesql.schema_migrations`: already-applied steps are verified for SQL immutability and skipped, while unapplied steps (`version > MAX(applied_version)`) are executed. All unapplied transactional steps in a single request execute atomically within one database transaction (BEGIN ... COMMIT): either every unapplied step commits and is recorded in the ledger, or the entire request rolls back. An unapplied step containing CREATE INDEX CONCURRENTLY or DROP INDEX CONCURRENTLY cannot be mixed with other unapplied steps and must be the sole unapplied step executed in the request.",
+"items": {
+"$ref": "MigrationStep"
+},
+"type": "array"
+},
+"validateOnly": {
+"description": "Optional. When true, runs preflight validation (syntax, applied-step immutability, sequence ordering, CONCURRENTLY isolation, and SAVEPOINT catalog checks) without committing mutations to the database.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"MigrationStep": {
+"description": "An individual unit of migration work. Next tag: 4",
+"id": "MigrationStep",
+"properties": {
+"name": {
+"description": "Optional. Descriptive migration label (e.g. \"create_accounts_table\"). If omitted, defaults to \"adhoc\".",
+"type": "string"
+},
+"sql": {
+"description": "Required. Raw multi-statement SQL script. The backend splits it into individual statements before execution; callers do not pre-split. Required whenever the request executes or records DDL, which is every publicly available execution mode; omitting it returns INVALID_ARGUMENT.",
+"type": "string"
+},
+"version": {
+"description": "Optional. Monotonic 14-digit UTC timestamp (YYYYMMDDHHMMSS), matching the timestamp prefix of the developer's migration filename. Constrained to `^[0-9]{14}$`. - When specified (file migrations): If `version` is already recorded in `firebasesql.schema_migrations`, the backend verifies that `sql` matches the recorded statements and skips execution. If `version` is unapplied, the backend validates `version > MAX(applied_version)` and records the value unchanged, so the ledger row and the on-disk filename stay identical. - When omitted (Console/ad-hoc): Backend auto-generates a 14-digit UTC timestamp.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Operation": {
 "description": "This resource represents a long-running operation that is the result of a network API call.",
 "id": "Operation",
diff --git a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json
index 4106dd58b0..019b520bd5 100644
--- a/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json
+++ b/googleapiclient/discovery_cache/documents/firebasedataconnect.v1beta.json
@@ -1163,6 +1163,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"migrate": {
+"description": "Executes SQL migration steps against the active database schema. This operation compares submitted migration steps against the schema migration ledger (`firebasesql.schema_migrations`), executes unapplied DDL, and records applied steps. It does NOT persist the GraphQL schema to the control plane.",
+"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}:migrate",
+"httpMethod": "POST",
+"id": "firebasedataconnect.projects.locations.services.schemas.migrate",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. Resource name of the target schema: projects/{project}/locations/{location}/services/{service}/schemas/{schema} Note: Only `schemas/main` is supported (singleton schema per service).",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/services/[^/]+/schemas/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta/{+name}:migrate",
+"request": {
+"$ref": "MigrateSchemaRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "patch": {
 "description": "Updates the parameters of a single Schema, and creates a new SchemaRevision with the updated Schema.",
 "flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}/services/{servicesId}/schemas/{schemasId}",
@@ -1221,7 +1249,7 @@
 }
 }
 },
-"revision": "20260726",
+"revision": "20260927",
 "rootUrl": "https://firebasedataconnect.googleapis.com/",
 "schemas": {
 "CancelOperationRequest": {
@@ -1999,6 +2027,59 @@
 },
 "type": "object"
 },
+"MigrateSchemaRequest": {
+"description": "Request message for `MigrateSchema`. Next tag: 7",
+"id": "MigrateSchemaRequest",
+"properties": {
+"executionMode": {
+"description": "Optional. Execution mode controlling DDL execution and ledger recording. Defaults to EXECUTE_AND_RECORD.",
+"enum": [
+"EXECUTION_MODE_UNSPECIFIED",
+"EXECUTE_AND_RECORD",
+"EXECUTE_ONLY",
+"RECORD_ONLY"
+],
+"enumDescriptions": [
+"Default behavior. Evaluates to EXECUTE_AND_RECORD.",
+"Standard execution: executes DDL statements against the database catalog and records completed steps in `firebasesql.schema_migrations`.",
+"Applies DDL statements against the database catalog without writing to the ledger. Used for maintenance scripts, temporary schema objects, and the internal declarative flow.",
+"Records steps into `firebasesql.schema_migrations` without executing their DDL statements. Used for baselining pre-existing schemas or manual out-of-band changes (e.g. ledger-only)."
+],
+"type": "string"
+},
+"migrationSteps": {
+"description": "Required. Ordered migration steps from `./sql/migrations/` (or a single ad-hoc step). Backend compares submitted versions against `firebasesql.schema_migrations`: already-applied steps are verified for SQL immutability and skipped, while unapplied steps (`version > MAX(applied_version)`) are executed. All unapplied transactional steps in a single request execute atomically within one database transaction (BEGIN ... COMMIT): either every unapplied step commits and is recorded in the ledger, or the entire request rolls back. An unapplied step containing CREATE INDEX CONCURRENTLY or DROP INDEX CONCURRENTLY cannot be mixed with other unapplied steps and must be the sole unapplied step executed in the request.",
+"items": {
+"$ref": "MigrationStep"
+},
+"type": "array"
+},
+"validateOnly": {
+"description": "Optional. When true, runs preflight validation (syntax, applied-step immutability, sequence ordering, CONCURRENTLY isolation, and SAVEPOINT catalog checks) without committing mutations to the database.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"MigrationStep": {
+"description": "An individual unit of migration work. Next tag: 4",
+"id": "MigrationStep",
+"properties": {
+"name": {
+"description": "Optional. Descriptive migration label (e.g. \"create_accounts_table\"). If omitted, defaults to \"adhoc\".",
+"type": "string"
+},
+"sql": {
+"description": "Required. Raw multi-statement SQL script. The backend splits it into individual statements before execution; callers do not pre-split. Required whenever the request executes or records DDL, which is every publicly available execution mode; omitting it returns INVALID_ARGUMENT.",
+"type": "string"
+},
+"version": {
+"description": "Optional. Monotonic 14-digit UTC timestamp (YYYYMMDDHHMMSS), matching the timestamp prefix of the developer's migration filename. Constrained to `^[0-9]{14}$`. - When specified (file migrations): If `version` is already recorded in `firebasesql.schema_migrations`, the backend verifies that `sql` matches the recorded statements and skips execution. If `version` is unapplied, the backend validates `version > MAX(applied_version)` and records the value unchanged, so the ledger row and the on-disk filename stay identical. - When omitted (Console/ad-hoc): Backend auto-generates a 14-digit UTC timestamp.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "Operation": {
 "description": "This resource represents a long-running operation that is the result of a network API call.",
 "id": "Operation",

From b0f34b60f507f77b82ae5b25e0640c18c6c2f6b9 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 6 Oct 2026 07:25:37 +0000
Subject: [PATCH 22/41] feat(gkehub): update the api

#### gkehub:v1

The following keys were added:
- schemas.Rollout.properties.prioritized.type (Total Keys: 1)
- schemas.UpgradeRolloutSequenceRequest.properties.prioritized.type (Total Keys: 1)

#### gkehub:v1alpha

The following keys were added:
- schemas.Rollout.properties.prioritized.type (Total Keys: 1)
- schemas.UpgradeRolloutSequenceRequest.properties.prioritized.type (Total Keys: 1)

#### gkehub:v1beta

The following keys were added:
- schemas.Rollout.properties.prioritized.type (Total Keys: 1)
- schemas.UpgradeRolloutSequenceRequest.properties.prioritized.type (Total Keys: 1)
---
 .../gkehub_v1.projects.locations.rolloutSequences.html |  1 +
 docs/dyn/gkehub_v1.projects.locations.rollouts.html    |  2 ++
 ...ub_v1alpha.projects.locations.rolloutSequences.html |  1 +
 .../gkehub_v1alpha.projects.locations.rollouts.html    |  2 ++
 ...hub_v1beta.projects.locations.rolloutSequences.html |  1 +
 .../dyn/gkehub_v1beta.projects.locations.rollouts.html |  2 ++
 .../discovery_cache/documents/gkehub.v1.json           | 10 +++++++++-
 .../discovery_cache/documents/gkehub.v1alpha.json      | 10 +++++++++-
 .../discovery_cache/documents/gkehub.v1beta.json       | 10 +++++++++-
 9 files changed, 36 insertions(+), 3 deletions(-)

diff --git a/docs/dyn/gkehub_v1.projects.locations.rolloutSequences.html b/docs/dyn/gkehub_v1.projects.locations.rolloutSequences.html
index a8071903b2..c771d2f414 100644
--- a/docs/dyn/gkehub_v1.projects.locations.rolloutSequences.html
+++ b/docs/dyn/gkehub_v1.projects.locations.rolloutSequences.html
@@ -519,6 +519,7 @@ 

Method Details

"ignoreClusterDisruptionBudgets": True or False, # Optional. If set to true, the rollout will ignore the disruption budgets of the clusters. "ignoreMaintenancePolicies": True or False, # Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters. "patchOnly": True or False, # Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version. + "prioritized": True or False, # Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created. "soakDurationOverrideAllStages": "A String", # Optional. Overrides the soak duration for all stages of the rollout. "soakDurationOverridePerStage": { # Configuration for per-stage soak duration overrides. # Optional. Overrides the soak durations for specific stages of the rollout. "stageOverrides": { # Required. A mapping of stage numbers to their respective desired soak durations. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. diff --git a/docs/dyn/gkehub_v1.projects.locations.rollouts.html b/docs/dyn/gkehub_v1.projects.locations.rollouts.html index 50dfbebce8..bc1bf95a4d 100644 --- a/docs/dyn/gkehub_v1.projects.locations.rollouts.html +++ b/docs/dyn/gkehub_v1.projects.locations.rollouts.html @@ -268,6 +268,7 @@

Method Details

}, }, "name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`. + "prioritized": True or False, # Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created. "rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`. "stageSoakDurationOverrides": { # Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. "a_key": "A String", @@ -348,6 +349,7 @@

Method Details

}, }, "name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`. + "prioritized": True or False, # Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created. "rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`. "stageSoakDurationOverrides": { # Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. "a_key": "A String", diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.rolloutSequences.html b/docs/dyn/gkehub_v1alpha.projects.locations.rolloutSequences.html index 8df0234d88..cbae0f978c 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.rolloutSequences.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.rolloutSequences.html @@ -519,6 +519,7 @@

Method Details

"ignoreClusterDisruptionBudgets": True or False, # Optional. If set to true, the rollout will ignore the disruption budgets of the clusters. "ignoreMaintenancePolicies": True or False, # Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters. "patchOnly": True or False, # Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version. + "prioritized": True or False, # Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created. "soakDurationOverrideAllStages": "A String", # Optional. Overrides the soak duration for all stages of the rollout. "soakDurationOverridePerStage": { # Configuration for per-stage soak duration overrides. # Optional. Overrides the soak durations for specific stages of the rollout. "stageOverrides": { # Required. A mapping of stage numbers to their respective desired soak durations. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. diff --git a/docs/dyn/gkehub_v1alpha.projects.locations.rollouts.html b/docs/dyn/gkehub_v1alpha.projects.locations.rollouts.html index 38ed9d5ec7..f4b0a78a8e 100644 --- a/docs/dyn/gkehub_v1alpha.projects.locations.rollouts.html +++ b/docs/dyn/gkehub_v1alpha.projects.locations.rollouts.html @@ -268,6 +268,7 @@

Method Details

}, }, "name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`. + "prioritized": True or False, # Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created. "rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`. "stageSoakDurationOverrides": { # Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. "a_key": "A String", @@ -348,6 +349,7 @@

Method Details

}, }, "name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`. + "prioritized": True or False, # Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created. "rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`. "stageSoakDurationOverrides": { # Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. "a_key": "A String", diff --git a/docs/dyn/gkehub_v1beta.projects.locations.rolloutSequences.html b/docs/dyn/gkehub_v1beta.projects.locations.rolloutSequences.html index bea275756d..44f6fd43b4 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.rolloutSequences.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.rolloutSequences.html @@ -519,6 +519,7 @@

Method Details

"ignoreClusterDisruptionBudgets": True or False, # Optional. If set to true, the rollout will ignore the disruption budgets of the clusters. "ignoreMaintenancePolicies": True or False, # Optional. If set to true, the rollout will ignore any maintenance policies (Maintenance Windows and Maintenance Exclusions) set on the clusters. "patchOnly": True or False, # Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version. + "prioritized": True or False, # Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created. "soakDurationOverrideAllStages": "A String", # Optional. Overrides the soak duration for all stages of the rollout. "soakDurationOverridePerStage": { # Configuration for per-stage soak duration overrides. # Optional. Overrides the soak durations for specific stages of the rollout. "stageOverrides": { # Required. A mapping of stage numbers to their respective desired soak durations. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. diff --git a/docs/dyn/gkehub_v1beta.projects.locations.rollouts.html b/docs/dyn/gkehub_v1beta.projects.locations.rollouts.html index 2342d4e554..dc8f69621e 100644 --- a/docs/dyn/gkehub_v1beta.projects.locations.rollouts.html +++ b/docs/dyn/gkehub_v1beta.projects.locations.rollouts.html @@ -268,6 +268,7 @@

Method Details

}, }, "name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`. + "prioritized": True or False, # Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created. "rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`. "stageSoakDurationOverrides": { # Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. "a_key": "A String", @@ -348,6 +349,7 @@

Method Details

}, }, "name": "A String", # Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`. + "prioritized": True or False, # Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created. "rolloutSequence": "A String", # Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`. "stageSoakDurationOverrides": { # Optional. Overrides the soak durations for specific stages of the rollout. Key is the stage number, value is the desired soak duration. Stages omitted from the map will receive the standard soak duration configured on the sequence for that stage. "a_key": "A String", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1.json b/googleapiclient/discovery_cache/documents/gkehub.v1.json index 8944b633c2..9fcddc0567 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1.json @@ -2596,7 +2596,7 @@ } } }, -"revision": "20260903", +"revision": "20260927", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -6895,6 +6895,10 @@ "description": "Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`.", "type": "string" }, +"prioritized": { +"description": "Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created.", +"type": "boolean" +}, "rolloutSequence": { "description": "Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`.", "type": "string" @@ -8142,6 +8146,10 @@ false "description": "Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version.", "type": "boolean" }, +"prioritized": { +"description": "Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created.", +"type": "boolean" +}, "soakDurationOverrideAllStages": { "description": "Optional. Overrides the soak duration for all stages of the rollout.", "format": "google-duration", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json index cb55b917fb..4ea70a03f5 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1alpha.json @@ -2740,7 +2740,7 @@ } } }, -"revision": "20260903", +"revision": "20260927", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -7408,6 +7408,10 @@ "description": "Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`.", "type": "string" }, +"prioritized": { +"description": "Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created.", +"type": "boolean" +}, "rolloutSequence": { "description": "Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`.", "type": "string" @@ -8777,6 +8781,10 @@ false "description": "Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version.", "type": "boolean" }, +"prioritized": { +"description": "Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created.", +"type": "boolean" +}, "soakDurationOverrideAllStages": { "description": "Optional. Overrides the soak duration for all stages of the rollout.", "format": "google-duration", diff --git a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json index 339a20fd56..bb56ba805b 100644 --- a/googleapiclient/discovery_cache/documents/gkehub.v1beta.json +++ b/googleapiclient/discovery_cache/documents/gkehub.v1beta.json @@ -2596,7 +2596,7 @@ } } }, -"revision": "20260903", +"revision": "20260927", "rootUrl": "https://gkehub.googleapis.com/", "schemas": { "AppDevExperienceFeatureSpec": { @@ -7021,6 +7021,10 @@ "description": "Identifier. The full, unique resource name of this Rollout in the format of `projects/{project}/locations/global/rollouts/{rollout}`.", "type": "string" }, +"prioritized": { +"description": "Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created.", +"type": "boolean" +}, "rolloutSequence": { "description": "Optional. Immutable. The full, unique resource name of the rollout sequence that initiatied this Rollout. In the format of `projects/{project}/locations/global/rolloutSequences/{rollout_sequence}`.", "type": "string" @@ -8268,6 +8272,10 @@ false "description": "Optional. If set to true, the rollout will only upgrade clusters that match the minor version of the `version` field, but are on an earlier patch version.", "type": "boolean" }, +"prioritized": { +"description": "Optional. If set to true, conflicting rollouts will be paused, to allow this rollout to progress through the sequence. Conflicting rollouts running on the first stage will be canceled, to allow this rollout to be created.", +"type": "boolean" +}, "soakDurationOverrideAllStages": { "description": "Optional. Overrides the soak duration for all stages of the rollout.", "format": "google-duration", From 041b4a791d3bd8a692f89738d6c2f5174a762ee2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:37 +0000 Subject: [PATCH 23/41] feat(health): update the api #### health:v4 The following keys were added: - resources.users.resources.dataTypes.resources.dataPoints.methods.list.parameters.dataSourceFamily (Total Keys: 2) - schemas.DailyRollUpDataPointsResponse.properties.nextPageToken.type (Total Keys: 1) The following keys were changed: - resources.users.resources.dataTypes.resources.dataPoints.methods.dailyRollUp.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.get.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.list.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.reconcile.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.rollUp.scopes (Total Keys: 1) #### health:v4beta The following keys were added: - resources.users.resources.dataTypes.resources.dataPoints.methods.list.parameters.dataSourceFamily (Total Keys: 2) - schemas.DailyRollUpDataPointsResponse.properties.nextPageToken.type (Total Keys: 1) - schemas.DailyRollupDataPoint.properties.skinTemperature.$ref (Total Keys: 1) - schemas.DataPoint.properties.skinTemperature (Total Keys: 2) - schemas.ReconciledDataPoint.properties.skinTemperature (Total Keys: 2) - schemas.RollupDataPoint.properties.skinTemperature.$ref (Total Keys: 1) - schemas.SensorData (Total Keys: 5) - schemas.SensorMetadata (Total Keys: 5) - schemas.SkinTemperature (Total Keys: 25) The following keys were changed: - resources.users.resources.dataTypes.resources.dataPoints.methods.dailyRollUp.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.get.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.list.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.reconcile.scopes (Total Keys: 1) - resources.users.resources.dataTypes.resources.dataPoints.methods.rollUp.scopes (Total Keys: 1) --- .../health_v4.users.dataTypes.dataPoints.html | 35 +- ...lth_v4beta.users.dataTypes.dataPoints.html | 315 +++++++++++++++++- .../discovery_cache/documents/health.v4.json | 25 +- .../documents/health.v4beta.json | 226 ++++++++++++- 4 files changed, 579 insertions(+), 22 deletions(-) diff --git a/docs/dyn/health_v4.users.dataTypes.dataPoints.html b/docs/dyn/health_v4.users.dataTypes.dataPoints.html index 9ffde381d0..869d93a3ae 100644 --- a/docs/dyn/health_v4.users.dataTypes.dataPoints.html +++ b/docs/dyn/health_v4.users.dataTypes.dataPoints.html @@ -86,6 +86,9 @@

Instance Methods

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

Roll up data points over civil time intervals for supported data types.

+

+ dailyRollUp_next(previous_request, previous_response)

+

Retrieves the next page of results.

exportExerciseTcx(name, partialData=None, x__xgafv=None)

Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.

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

Instance Methods

get(name, x__xgafv=None)

Get a single identifyable data point.

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

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

Query user health and fitness data points.

list_next(previous_request, previous_response)

@@ -900,7 +903,7 @@

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. - "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "metadata": { # Metadata for HeartRateVariability. # Optional. Additional information about the heart rate variability measurement. "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). }, @@ -1641,7 +1644,7 @@

Method Details

{ # Request to roll up data points by civil time intervals. "dataSourceFamily": "A String", # Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/me/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error. "pageSize": 42, # Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. - "pageToken": "A String", # Optional. The `next_page_token` from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified. + "pageToken": "A String", # Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified. "range": { # Counterpart of google.type.Interval, but using CivilDateTime. # Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days. "end": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Required. The exclusive end of the range. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. @@ -1682,6 +1685,7 @@

Method Details

An object of the form: { # Response containing the list of rolled up data points. + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "rollupDataPoints": [ # Values for each aggregation time window. { # Value of a daily rollup for a single civil time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn. "activeEnergyBurned": { # Represents the result of the rollup of active energy burned. # Returned by default when rolling up data points from the `active-energy-burned` data type. @@ -1841,6 +1845,20 @@

Method Details

}
+
+ dailyRollUp_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.
+
+
+
exportExerciseTcx(name, partialData=None, x__xgafv=None)
Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.
@@ -2618,7 +2636,7 @@ 

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. - "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "metadata": { # Metadata for HeartRateVariability. # Optional. Additional information about the heart rate variability measurement. "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). }, @@ -3320,11 +3338,12 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, dataSourceFamily=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Query user health and fitness data points.
 
 Args:
   parent: string, Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/weight` For a list of the supported data types see the DataPoint data union field. (required)
+  dataSourceFamily: string, Optional. The data source family name to filter by. If empty, data points from all available data sources will be returned. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/me/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data types may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error. Filtering by data source family is not supported for the `sleep`, `food` and `food-measurement-unit` data types, because the underlying listing implementation cannot restrict results by data source. Such requests fail with `INVALID_ARGUMENT` when the data source family is set explicitly, and with `PERMISSION_DENIED` when the restriction is only implied by the caller's scopes. For `sleep`, use ReconcileDataPoints instead.
   filter: string, Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time >= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time >= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time >= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < "2024-08-15"` - Session civil start time (**Excluding Sleep and ECG**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time >= "2024-08-14T12:34:56"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= "2024-08-14T12:34:56Z"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order.
   pageSize: integer, Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.
   pageToken: string, Optional. The `next_page_token` from a previous request, if any.
@@ -4063,7 +4082,7 @@ 

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. - "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "metadata": { # Metadata for HeartRateVariability. # Optional. Additional information about the heart rate variability measurement. "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). }, @@ -5515,7 +5534,7 @@

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. - "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "metadata": { # Metadata for HeartRateVariability. # Optional. Additional information about the heart rate variability measurement. "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). }, @@ -6866,7 +6885,7 @@

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Data for points in the `heart-rate-variability` sample data type collection. - "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "metadata": { # Metadata for HeartRateVariability. # Optional. Additional information about the heart rate variability measurement. "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). }, diff --git a/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html b/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html index d933f8aa96..ca0f46f337 100644 --- a/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html +++ b/docs/dyn/health_v4beta.users.dataTypes.dataPoints.html @@ -86,6 +86,9 @@

Instance Methods

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

Roll up data points over civil time intervals for supported data types.

+

+ dailyRollUp_next(previous_request, previous_response)

+

Retrieves the next page of results.

exportExerciseTcx(name, partialData=None, x__xgafv=None)

Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.

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

Instance Methods

get(name, x__xgafv=None)

Get a single identifyable data point.

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

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

Query user health and fitness data points.

list_next(previous_request, previous_response)

@@ -900,7 +903,7 @@

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. - "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "metadata": { # Metadata for HeartRateVariability. # Optional. Additional information about the heart rate variability measurement. "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). }, @@ -1339,6 +1342,60 @@

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": { # ////////////////////////////////////////////////////////////////////////// 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. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal 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). + }, + "sensorData": [ # Required. Repeated sensor data readings for this sample. + { # Individual sensor reading and metadata. + "metadata": { # Metadata for the sensor measurement. # Optional. Metadata for the sensor reading. + "measurementLocation": "A String", # Optional. The location of the sensor measurement. + "measurementState": "A String", # Optional. The motion state of the sensor measurement. + "sensorType": "A String", # Optional. The type of the sensor. + }, + "temperatureCelsius": 3.14, # Required. The temperature reading in Celsius. + }, + ], + }, "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection. "createTime": "A String", # Output only. Creation time of this sleep observation. "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep interval. @@ -1641,7 +1698,7 @@

Method Details

{ # Request to roll up data points by civil time intervals. "dataSourceFamily": "A String", # Optional. The data source family name to roll up. If empty, data points from all available data sources will be rolled up. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/me/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data type may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error. "pageSize": 42, # Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. - "pageToken": "A String", # Optional. The `next_page_token` from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified. + "pageToken": "A String", # Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified. "range": { # Counterpart of google.type.Interval, but using CivilDateTime. # Required. Closed-open range of data points that will be rolled up. The start time must be aligned with the aggregation window. The maximum range for `calories-in-heart-rate-zone`, `heart-rate`, `active-minutes` and `total-calories` is 14 days. The maximum range for all other data types is 90 days. "end": { # Civil time representation similar to google.type.DateTime, but ensures that neither the timezone nor the UTC offset can be set to avoid confusion between civil and physical time queries. # Required. The exclusive end of the range. "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. @@ -1682,6 +1739,7 @@

Method Details

An object of the form: { # Response containing the list of rolled up data points. + "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "rollupDataPoints": [ # Values for each aggregation time window. { # Value of a daily rollup for a single civil time interval (aggregation window) of reconciled data points from all data sources, excluding those data points that are identified as recorded by wearables in intervals when they were not actually worn. "activeEnergyBurned": { # Represents the result of the rollup of active energy burned. # Returned by default when rolling up data points from the `active-energy-burned` data type. @@ -1816,6 +1874,11 @@

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. }, @@ -1841,6 +1904,20 @@

Method Details

}
+
+ dailyRollUp_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.
+
+
+
exportExerciseTcx(name, partialData=None, x__xgafv=None)
Exports exercise data in TCX format. **IMPORTANT:** HTTP clients must append `?alt=media` to the request URL to download the raw TCX file. Example: `https://health.googleapis.com/v4/users/me/dataTypes/exercise/dataPoints/EXERCISE_ID:exportExerciseTcx?alt=media` Without `alt=media`, the server returns a JSON response (`ExportExerciseTcxResponse`) which is intended primarily for gRPC clients. **Note:** While the Authorization section below states that any one of the listed scopes is accepted, this specific method requires the user to provide both one of the `activity_and_fitness` scopes (`normal` or `readonly`) AND one of the `location` scopes (`normal` or `readonly`) in their access token to succeed.
@@ -2618,7 +2695,7 @@ 

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. - "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "metadata": { # Metadata for HeartRateVariability. # Optional. Additional information about the heart rate variability measurement. "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). }, @@ -3057,6 +3134,60 @@

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": { # ////////////////////////////////////////////////////////////////////////// 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. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal 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). + }, + "sensorData": [ # Required. Repeated sensor data readings for this sample. + { # Individual sensor reading and metadata. + "metadata": { # Metadata for the sensor measurement. # Optional. Metadata for the sensor reading. + "measurementLocation": "A String", # Optional. The location of the sensor measurement. + "measurementState": "A String", # Optional. The motion state of the sensor measurement. + "sensorType": "A String", # Optional. The type of the sensor. + }, + "temperatureCelsius": 3.14, # Required. The temperature reading in Celsius. + }, + ], + }, "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection. "createTime": "A String", # Output only. Creation time of this sleep observation. "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep interval. @@ -3320,11 +3451,12 @@

Method Details

- list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None) + list(parent, dataSourceFamily=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Query user health and fitness data points.
 
 Args:
   parent: string, Required. Parent data type of the Data Point collection. Format: `users/me/dataTypes/{data_type}`, e.g.: - `users/me/dataTypes/steps` - `users/me/dataTypes/weight` For a list of the supported data types see the DataPoint data union field. (required)
+  dataSourceFamily: string, Optional. The data source family name to filter by. If empty, data points from all available data sources will be returned. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/me/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data types may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error. Filtering by data source family is not supported for the `sleep`, `food` and `food-measurement-unit` data types, because the underlying listing implementation cannot restrict results by data source. Such requests fail with `INVALID_ARGUMENT` when the data source family is set explicitly, and with `PERMISSION_DENIED` when the restriction is only implied by the caller's scopes. For `sleep`, use ReconcileDataPoints instead.
   filter: string, Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= "2023-11-24T00:00:00Z" AND steps.interval.start_time < "2023-11-25T00:00:00Z"` - `distance.interval.start_time >= "2024-08-14T12:34:56Z"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= "2023-11-24" AND steps.interval.civil_start_time < "2023-11-25"` - `distance.interval.civil_start_time >= "2024-08-14T12:34:56"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= "2023-11-24T00:00:00Z" AND weight.sample_time.physical_time < "2023-11-25T00:00:00Z"` - `weight.sample_time.physical_time >= "2024-08-14T12:34:56Z"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= "2023-11-24" AND weight.sample_time.civil_time < "2023-11-25"` - `weight.sample_time.civil_time >= "2024-08-14T12:34:56"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < "2024-08-15"` - Session civil start time (**Excluding Sleep and ECG**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= "2023-11-24" AND exercise.interval.civil_start_time < "2023-11-25"` - `exercise.interval.civil_start_time >= "2024-08-14T12:34:56"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= "2024-08-14T12:34:56Z"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= "2023-11-24T00:00:00Z" AND sleep.interval.end_time < "2023-11-25T00:00:00Z"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= "2023-11-24" AND sleep.interval.civil_end_time < "2023-11-25"` Data points in the response will be ordered by the interval start time in descending order.
   pageSize: integer, Optional. The maximum number of data points to return. If unspecified, at most 1440 data points will be returned. The maximum page size is 10000; values above that will be truncated accordingly. For `exercise` and `sleep` the default page size is 25. The maximum page size for `exercise` and `sleep` is 25.
   pageToken: string, Optional. The `next_page_token` from a previous request, if any.
@@ -4063,7 +4195,7 @@ 

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. - "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "metadata": { # Metadata for HeartRateVariability. # Optional. Additional information about the heart rate variability measurement. "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). }, @@ -4502,6 +4634,60 @@

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": { # ////////////////////////////////////////////////////////////////////////// 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. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal 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). + }, + "sensorData": [ # Required. Repeated sensor data readings for this sample. + { # Individual sensor reading and metadata. + "metadata": { # Metadata for the sensor measurement. # Optional. Metadata for the sensor reading. + "measurementLocation": "A String", # Optional. The location of the sensor measurement. + "measurementState": "A String", # Optional. The motion state of the sensor measurement. + "sensorType": "A String", # Optional. The type of the sensor. + }, + "temperatureCelsius": 3.14, # Required. The temperature reading in Celsius. + }, + ], + }, "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection. "createTime": "A String", # Output only. Creation time of this sleep observation. "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep interval. @@ -5515,7 +5701,7 @@

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Optional. Data for points in the `heart-rate-variability` sample data type collection. - "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "metadata": { # Metadata for HeartRateVariability. # Optional. Additional information about the heart rate variability measurement. "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). }, @@ -5954,6 +6140,60 @@

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": { # ////////////////////////////////////////////////////////////////////////// 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. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal 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). + }, + "sensorData": [ # Required. Repeated sensor data readings for this sample. + { # Individual sensor reading and metadata. + "metadata": { # Metadata for the sensor measurement. # Optional. Metadata for the sensor reading. + "measurementLocation": "A String", # Optional. The location of the sensor measurement. + "measurementState": "A String", # Optional. The motion state of the sensor measurement. + "sensorType": "A String", # Optional. The type of the sensor. + }, + "temperatureCelsius": 3.14, # Required. The temperature reading in Celsius. + }, + ], + }, "sleep": { # A sleep session possibly including stages. # Optional. Data for points in the `sleep` session data type collection. "createTime": "A String", # Output only. Creation time of this sleep observation. "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep interval. @@ -6866,7 +7106,7 @@

Method Details

}, }, "heartRateVariability": { # Captures user's heart rate variability (HRV) as measured by the root mean square of successive differences (RMSSD) between normal heartbeats or by standard deviation of the inter-beat intervals (SDNN). # Data for points in the `heart-rate-variability` sample data type collection. - "metadata": { # Metadata for HeartRateVariability. # Optional. Metadata used in 1P surfaces. + "metadata": { # Metadata for HeartRateVariability. # Optional. Additional information about the heart rate variability measurement. "highFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the high frequency band (0.15 Hz - 0.4 Hz). "lowFrequencyPower": 3.14, # Optional. The power in interbeat interval fluctuations within the low frequency band (0.04 Hz - 0.15 Hz). }, @@ -7128,6 +7368,60 @@

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": { # ////////////////////////////////////////////////////////////////////////// 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. + "date": { # Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp # Required. Calendar date. + "day": 42, # Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. + "month": 42, # Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day. + "year": 42, # Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. + }, + "time": { # Represents a time of day. The date and time zone are either not significant or are specified elsewhere. An API may choose to allow leap seconds. Related types are google.type.Date and `google.protobuf.Timestamp`. # Optional. Time of day. Defaults to the start of the day, at midnight if omitted. + "hours": 42, # Hours of a day in 24 hour format. Must be greater than or equal to 0 and typically must be less than or equal to 23. An API may choose to allow the value "24:00:00" for scenarios like business closing time. + "minutes": 42, # Minutes of an hour. Must be greater than or equal to 0 and less than or equal to 59. + "nanos": 42, # Fractions of seconds, in nanoseconds. Must be greater than or equal to 0 and less than or equal to 999,999,999. + "seconds": 42, # Seconds of a minute. Must be greater than or equal 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). + }, + "sensorData": [ # Required. Repeated sensor data readings for this sample. + { # Individual sensor reading and metadata. + "metadata": { # Metadata for the sensor measurement. # Optional. Metadata for the sensor reading. + "measurementLocation": "A String", # Optional. The location of the sensor measurement. + "measurementState": "A String", # Optional. The motion state of the sensor measurement. + "sensorType": "A String", # Optional. The type of the sensor. + }, + "temperatureCelsius": 3.14, # Required. The temperature reading in Celsius. + }, + ], + }, "sleep": { # A sleep session possibly including stages. # Data for points in the `sleep` session data type collection. "createTime": "A String", # Output only. Creation time of this sleep observation. "interval": { # Represents a time interval of session data point, which bundles multiple observed metrics together. # Required. Observed sleep interval. @@ -7516,6 +7810,11 @@

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/googleapiclient/discovery_cache/documents/health.v4.json b/googleapiclient/discovery_cache/documents/health.v4.json index 7e0c94dce9..17ba7b012a 100644 --- a/googleapiclient/discovery_cache/documents/health.v4.json +++ b/googleapiclient/discovery_cache/documents/health.v4.json @@ -789,8 +789,10 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", @@ -860,8 +862,10 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", @@ -883,6 +887,11 @@ "parent" ], "parameters": { +"dataSourceFamily": { +"description": "Optional. The data source family name to filter by. If empty, data points from all available data sources will be returned. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/me/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data types may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error. Filtering by data source family is not supported for the `sleep`, `food` and `food-measurement-unit` data types, because the underlying listing implementation cannot restrict results by data source. Such requests fail with `INVALID_ARGUMENT` when the data source family is set explicitly, and with `PERMISSION_DENIED` when the restriction is only implied by the caller's scopes. For `sleep`, use ReconcileDataPoints instead.", +"location": "query", +"type": "string" +}, "filter": { "description": "Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= \"2023-11-24T00:00:00Z\" AND steps.interval.start_time < \"2023-11-25T00:00:00Z\"` - `distance.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= \"2023-11-24\" AND steps.interval.civil_start_time < \"2023-11-25\"` - `distance.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= \"2023-11-24T00:00:00Z\" AND weight.sample_time.physical_time < \"2023-11-25T00:00:00Z\"` - `weight.sample_time.physical_time >= \"2024-08-14T12:34:56Z\"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= \"2023-11-24\" AND weight.sample_time.civil_time < \"2023-11-25\"` - `weight.sample_time.civil_time >= \"2024-08-14T12:34:56\"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < \"2024-08-15\"` - Session civil start time (**Excluding Sleep and ECG**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= \"2023-11-24\" AND exercise.interval.civil_start_time < \"2023-11-25\"` - `exercise.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= \"2023-11-24T00:00:00Z\" AND sleep.interval.end_time < \"2023-11-25T00:00:00Z\"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= \"2023-11-24\" AND sleep.interval.civil_end_time < \"2023-11-25\"` Data points in the response will be ordered by the interval start time in descending order.", "location": "query", @@ -914,8 +923,10 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", @@ -1007,8 +1018,10 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", @@ -1048,8 +1061,10 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", @@ -1134,7 +1149,7 @@ } } }, -"revision": "20260923", +"revision": "20261002", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveEnergyBurned": { @@ -1998,7 +2013,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. The `next_page_token` from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.", +"description": "Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.", "type": "string" }, "range": { @@ -2017,6 +2032,10 @@ "description": "Response containing the list of rolled up data points.", "id": "DailyRollUpDataPointsResponse", "properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, "rollupDataPoints": { "description": "Values for each aggregation time window.", "items": { @@ -3619,7 +3638,7 @@ "properties": { "metadata": { "$ref": "HeartRateVariabilityMetadata", -"description": "Optional. Metadata used in 1P surfaces." +"description": "Optional. Additional information about the heart rate variability measurement." }, "rootMeanSquareOfSuccessiveDifferencesMilliseconds": { "description": "Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health. Must be in the range `[1, 200]`.", diff --git a/googleapiclient/discovery_cache/documents/health.v4beta.json b/googleapiclient/discovery_cache/documents/health.v4beta.json index 435135b7f1..197c306761 100644 --- a/googleapiclient/discovery_cache/documents/health.v4beta.json +++ b/googleapiclient/discovery_cache/documents/health.v4beta.json @@ -789,8 +789,10 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", @@ -860,8 +862,10 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", @@ -883,6 +887,11 @@ "parent" ], "parameters": { +"dataSourceFamily": { +"description": "Optional. The data source family name to filter by. If empty, data points from all available data sources will be returned. Format: `users/me/dataSourceFamilies/{data_source_family}` The supported values are: - `users/me/dataSourceFamilies/all-sources` - Default value. Includes data from all available data sources. - `users/me/dataSourceFamilies/google-wearables` - Includes data from Google and Fitbit tracker devices (such as Fitbit trackers and Pixel Watch). Excludes manually logged data. - `users/me/dataSourceFamilies/google-sources` - Includes first-party Google data, such as data from tracker devices, manually logged data, and Health Connect. - `users/me/dataSourceFamilies/self-sources` - Includes only the data the calling client wrote through this API, that is, data points whose data source was registered through this API with the same OAuth client ID as the caller. Callers that were only granted write scopes for the requested data types may only read the data they wrote themselves: their requests are implicitly restricted to `self-sources`, and requesting any other data source family fails with `PERMISSION_DENIED`. If no data point matches the requested data source family, the response is an empty list rather than an error. Filtering by data source family is not supported for the `sleep`, `food` and `food-measurement-unit` data types, because the underlying listing implementation cannot restrict results by data source. Such requests fail with `INVALID_ARGUMENT` when the data source family is set explicitly, and with `PERMISSION_DENIED` when the restriction is only implied by the caller's scopes. For `sleep`, use ReconcileDataPoints instead.", +"location": "query", +"type": "string" +}, "filter": { "description": "Optional. Filter expression following https://google.aip.dev/160. A time range (either physical or civil) can be specified. The supported filter fields are: - Interval start time: - Pattern: `{interval_data_type}.interval.start_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `steps.interval.start_time >= \"2023-11-24T00:00:00Z\" AND steps.interval.start_time < \"2023-11-25T00:00:00Z\"` - `distance.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Interval civil start time: - Pattern: `{interval_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `steps.interval.civil_start_time >= \"2023-11-24\" AND steps.interval.civil_start_time < \"2023-11-25\"` - `distance.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Sample observation physical time: - Pattern: `{sample_data_type}.sample_time.physical_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND` - Example: - `weight.sample_time.physical_time >= \"2023-11-24T00:00:00Z\" AND weight.sample_time.physical_time < \"2023-11-25T00:00:00Z\"` - `weight.sample_time.physical_time >= \"2024-08-14T12:34:56Z\"` - Sample observation civil time: - Pattern: `{sample_data_type}.sample_time.civil_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `weight.sample_time.civil_time >= \"2023-11-24\" AND weight.sample_time.civil_time < \"2023-11-25\"` - `weight.sample_time.civil_time >= \"2024-08-14T12:34:56\"` - Daily summary date: - Pattern: `{daily_summary_data_type}.date` - Supported comparison operators: `>=`, `<` - Date literal expected in ISO 8601 `YYYY-MM-DD` format - Supported logical operators: `AND` - Example: - `daily_heart_rate_variability.date < \"2024-08-15\"` - Session civil start time (**Excluding Sleep and ECG**): - Pattern: `{session_data_type}.interval.civil_start_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND` - Example: - `exercise.interval.civil_start_time >= \"2023-11-24\" AND exercise.interval.civil_start_time < \"2023-11-25\"` - `exercise.interval.civil_start_time >= \"2024-08-14T12:34:56\"` - Session start time (**ECG specific**): - Pattern: `electrocardiogram.interval.start_time` - Supported comparison operators: `>=` - Timestamp literal expected in RFC-3339 format - Example: - `electrocardiogram.interval.start_time >= \"2024-08-14T12:34:56Z\"` - Note: Only filtering by start time is supported for ECG. Filtering by end time (e.g., `electrocardiogram.interval.end_time`) is not supported. - Session end time (**Sleep specific**): - Pattern: `sleep.interval.end_time` - Supported comparison operators: `>=`, `<` - Timestamp literal expected in RFC-3339 format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.end_time >= \"2023-11-24T00:00:00Z\" AND sleep.interval.end_time < \"2023-11-25T00:00:00Z\"` - Session civil end time (**Sleep specific**): - Pattern: `sleep.interval.civil_end_time` - Supported comparison operators: `>=`, `<` - Date with optional time literal expected in ISO 8601 `YYYY-MM-DD[THH:mm:ss]` format - Supported logical operators: `AND`, `OR` - Example: - `sleep.interval.civil_end_time >= \"2023-11-24\" AND sleep.interval.civil_end_time < \"2023-11-25\"` Data points in the response will be ordered by the interval start time in descending order.", "location": "query", @@ -914,8 +923,10 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", @@ -1007,8 +1018,10 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", @@ -1048,8 +1061,10 @@ "scopes": [ "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.readonly", "https://www.googleapis.com/auth/googlehealth.activity_and_fitness.writeonly", +"https://www.googleapis.com/auth/googlehealth.ecg.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.readonly", "https://www.googleapis.com/auth/googlehealth.health_metrics_and_measurements.writeonly", +"https://www.googleapis.com/auth/googlehealth.irn.readonly", "https://www.googleapis.com/auth/googlehealth.location.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.readonly", "https://www.googleapis.com/auth/googlehealth.logged_symptoms.writeonly", @@ -1134,7 +1149,7 @@ } } }, -"revision": "20260923", +"revision": "20261002", "rootUrl": "https://health.googleapis.com/", "schemas": { "ActiveEnergyBurned": { @@ -1998,7 +2013,7 @@ "type": "integer" }, "pageToken": { -"description": "Optional. The `next_page_token` from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.", +"description": "Optional. The next_page_token from a previous request, if any. All other request fields need to be the same as in the initial request when the page token is specified.", "type": "string" }, "range": { @@ -2017,6 +2032,10 @@ "description": "Response containing the list of rolled up data points.", "id": "DailyRollUpDataPointsResponse", "properties": { +"nextPageToken": { +"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.", +"type": "string" +}, "rollupDataPoints": { "description": "Values for each aggregation time window.", "items": { @@ -2111,6 +2130,10 @@ "$ref": "SedentaryPeriodRollupValue", "description": "Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier." }, +"skinTemperature": { +"$ref": "SkinTemperatureRollupValue", +"description": "Returned by default when rolling up data points from the `skin-temperature` data type." +}, "steps": { "$ref": "StepsRollupValue", "description": "Returned by default when rolling up data points from the `steps` data type, or when requested explicitly using the `steps` rollup type identifier." @@ -2359,6 +2382,14 @@ "$ref": "SedentaryPeriod", "description": "Optional. Data for points in the `sedentary-period` interval data type collection." }, +"skinTemperature": { +"$ref": "SkinTemperature", +"description": "Optional. Data for points in the `skin-temperature` sample data type collection." +}, +"skinTemperatureSensors": { +"$ref": "SkinTemperatureSensors", +"description": "Optional. Data for points in the `skin-temperature-sensors` sample data type collection." +}, "sleep": { "$ref": "Sleep", "description": "Optional. Data for points in the `sleep` session data type collection." @@ -3619,7 +3650,7 @@ "properties": { "metadata": { "$ref": "HeartRateVariabilityMetadata", -"description": "Optional. Metadata used in 1P surfaces." +"description": "Optional. Additional information about the heart rate variability measurement." }, "rootMeanSquareOfSuccessiveDifferencesMilliseconds": { "description": "Optional. The root mean square of successive differences between normal heartbeats. This is a measure of heart rate variability used by Google Health. Must be in the range `[1, 200]`.", @@ -5037,6 +5068,14 @@ "$ref": "SedentaryPeriod", "description": "Data for points in the `sedentary-period` interval data type collection." }, +"skinTemperature": { +"$ref": "SkinTemperature", +"description": "Data for points in the `skin-temperature` sample data type collection." +}, +"skinTemperatureSensors": { +"$ref": "SkinTemperatureSensors", +"description": "Data for points in the `skin-temperature-sensors` sample data type collection." +}, "sleep": { "$ref": "Sleep", "description": "Data for points in the `sleep` session data type collection." @@ -5250,6 +5289,10 @@ "$ref": "SedentaryPeriodRollupValue", "description": "Returned by default when rolling up data points from the `sedentary-period` data type, or when requested explicitly using the `sedentary-period` rollup type identifier." }, +"skinTemperature": { +"$ref": "SkinTemperatureRollupValue", +"description": "Returned by default when rolling up data points from the `skin-temperature` data type." +}, "startTime": { "description": "Start time of the window this value aggregates over", "format": "google-datetime", @@ -5339,6 +5382,77 @@ }, "type": "object" }, +"SensorData": { +"description": "Individual sensor reading and metadata.", +"id": "SensorData", +"properties": { +"metadata": { +"$ref": "SensorMetadata", +"description": "Optional. Metadata for the sensor reading." +}, +"temperatureCelsius": { +"description": "Required. The temperature reading in Celsius.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"SensorMetadata": { +"description": "Metadata for the sensor measurement.", +"id": "SensorMetadata", +"properties": { +"measurementLocation": { +"description": "Optional. The location of the sensor measurement.", +"enum": [ +"MEASUREMENT_LOCATION_UNSPECIFIED", +"OTHER", +"FINGER", +"TOE", +"WRIST" +], +"enumDescriptions": [ +"Measurement location is unspecified.", +"Other measurement location.", +"Finger measurement location.", +"Toe measurement location.", +"Wrist measurement location." +], +"type": "string" +}, +"measurementState": { +"description": "Optional. The motion state of the sensor measurement.", +"enum": [ +"MEASUREMENT_STATE_UNSPECIFIED", +"OTHER", +"AT_REST", +"SLEEP" +], +"enumDescriptions": [ +"Measurement state is unspecified.", +"Other measurement state.", +"Measurement state at rest.", +"Measurement state during sleep." +], +"type": "string" +}, +"sensorType": { +"description": "Optional. The type of the sensor.", +"enum": [ +"SENSOR_TYPE_UNSPECIFIED", +"SKIN_TEMPERATURE_SENSOR", +"INTERNAL_DEVICE_TEMPERATURE_SENSOR" +], +"enumDescriptions": [ +"Sensor type is unspecified.", +"Skin temperature sensor (bottom contact sensor).", +"Internal device temperature sensor (top/ambient sensor)." +], +"type": "string" +} +}, +"type": "object" +}, "Serving": { "description": "Represents different properties and information about the serving of a specific food.", "id": "Serving", @@ -5564,6 +5678,112 @@ }, "type": "object" }, +"SkinTemperature": { +"description": "////////////////////////////////////////////////////////////////////////// SkinTemperature ////////////////////////////////////////////////////////////////////////// Skin temperature measurement.", +"id": "SkinTemperature", +"properties": { +"baselineTemperatureCelsius": { +"description": "Required. The baseline skin temperature in Celsius. Must be in the range `[0, 100]`.", +"format": "double", +"type": "number" +}, +"metadata": { +"$ref": "SkinTemperatureMetadata", +"description": "Optional. Metadata for the skin temperature measurement." +}, +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The time at which skin temperature was measured." +}, +"temperatureCelsius": { +"description": "Required. The skin temperature in Celsius. Must be in the range `[0, 100]`.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"SkinTemperatureMetadata": { +"description": "Metadata for the skin temperature measurement.", +"id": "SkinTemperatureMetadata", +"properties": { +"measurementLocation": { +"description": "Optional. The location of the skin temperature measurement.", +"enum": [ +"MEASUREMENT_LOCATION_UNSPECIFIED", +"OTHER", +"FINGER", +"TOE", +"WRIST" +], +"enumDescriptions": [ +"Measurement location is unspecified.", +"Other measurement location.", +"Finger measurement location.", +"Toe measurement location.", +"Wrist measurement location." +], +"type": "string" +}, +"measurementState": { +"description": "Optional. The motion state of the skin temperature measurement.", +"enum": [ +"MEASUREMENT_STATE_UNSPECIFIED", +"MEASUREMENT_STATE_OTHER", +"MEASUREMENT_STATE_AT_REST", +"MEASUREMENT_STATE_SLEEP" +], +"enumDescriptions": [ +"Measurement state is unspecified.", +"Other measurement state.", +"Measurement state at rest.", +"Measurement state during sleep." +], +"type": "string" +} +}, +"type": "object" +}, +"SkinTemperatureRollupValue": { +"description": "Represents the result of the rollup of the skin temperature data type.", +"id": "SkinTemperatureRollupValue", +"properties": { +"temperatureCelsiusAvg": { +"description": "Average skin temperature in Celsius.", +"format": "double", +"type": "number" +}, +"temperatureCelsiusMax": { +"description": "Maximum skin temperature in Celsius.", +"format": "double", +"type": "number" +}, +"temperatureCelsiusMin": { +"description": "Minimum skin temperature in Celsius.", +"format": "double", +"type": "number" +} +}, +"type": "object" +}, +"SkinTemperatureSensors": { +"description": "Skin temperature sensor data containing multi-sensor readings.", +"id": "SkinTemperatureSensors", +"properties": { +"sampleTime": { +"$ref": "ObservationSampleTime", +"description": "Required. The observation sample time." +}, +"sensorData": { +"description": "Required. Repeated sensor data readings for this sample.", +"items": { +"$ref": "SensorData" +}, +"type": "array" +} +}, +"type": "object" +}, "Sleep": { "description": "A sleep session possibly including stages.", "id": "Sleep", From 7951150e68b96cfb844f360e36631a20a1560e03 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:38 +0000 Subject: [PATCH 24/41] feat(healthcare): update the api #### healthcare:v1beta1 The following keys were added: - resources.projects.resources.locations.resources.datasets.resources.fhirStores.methods.executeCohort (Total Keys: 12) - schemas.ExecuteCohortRequest (Total Keys: 7) - schemas.ExecuteCohortResponse (Total Keys: 3) - schemas.Expression (Total Keys: 4) - schemas.FHIRPathQuery (Total Keys: 5) --- ...rojects.locations.datasets.fhirStores.html | 2 +- ...rojects.locations.datasets.fhirStores.html | 60 ++++++++++- .../documents/healthcare.v1.json | 4 +- .../documents/healthcare.v1beta1.json | 101 +++++++++++++++++- 4 files changed, 161 insertions(+), 6 deletions(-) diff --git a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html index bb3adea0ab..cd0c193dec 100644 --- a/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1.projects.locations.datasets.fhirStores.html @@ -261,7 +261,7 @@

Method Details

}, "type": "A String", # Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) will be deleted. "until": "A String", # Optional. If provided, only resources updated before or atthis time are deleted. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone. - "validateOnly": True or False, # Optional. If set to true, the request will only perform a dry run. By default (once the behavior change is fully rolled out), this will default to true. During the transition period, the default depends on the Mendel flag status for the project. + "validateOnly": True or False, # Optional. If set to `true`, the request will only perform a dry run. By default this will default to `false`. "versionConfig": "A String", # Optional. Specifies which version of the resources to delete. } diff --git a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html index 7578a5b407..e7d805f020 100644 --- a/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html +++ b/docs/dyn/healthcare_v1beta1.projects.locations.datasets.fhirStores.html @@ -114,6 +114,9 @@

Instance Methods

delete(name, x__xgafv=None)

Deletes the specified FHIR store and removes all resources within it.

+

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

+

Executes and materializes a cohort definition from a FHIR store. This method returns an Operation that can be used to track the status of the cohort execution by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExecuteCohortResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.

explainDataAccess(name, resourceId=None, x__xgafv=None)

Explains all the permitted/denied actor, purpose and environment for a given resource. FHIR Consent is not supported in DSTU2 or R5.

@@ -273,7 +276,7 @@

Method Details

}, "type": "A String", # Optional. String of comma-delimited FHIR resource types. If provided, only resources of the specified resource type(s) will be deleted. "until": "A String", # Optional. If provided, only resources updated before or atthis time are deleted. The time uses the format YYYY-MM-DDThh:mm:ss.sss+zz:zz. For example, `2015-02-07T13:28:17.239+02:00` or `2017-01-01T00:00:00Z`. The time must be specified to the second and include a time zone. - "validateOnly": True or False, # Optional. If set to true, the request will only perform a dry run. By default (once the behavior change is fully rolled out), this will default to true. During the transition period, the default depends on the Mendel flag status for the project. + "validateOnly": True or False, # Optional. If set to `true`, the request will only perform a dry run. By default this will default to `false`. "versionConfig": "A String", # Optional. Specifies which version of the resources to delete. } @@ -1345,6 +1348,61 @@

Method Details

}
+
+ executeCohort(name, body=None, x__xgafv=None) +
Executes and materializes a cohort definition from a FHIR store. This method returns an Operation that can be used to track the status of the cohort execution by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExecuteCohortResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.
+
+Args:
+  name: string, Required. The name of the FHIR store to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`. (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request to execute a cohort definition from a FHIR store based on provided queries and sending the resulting subset of data to a specified sink.
+  "_at": "A String", # Optional. If provided, the queried resources will represent the state of the FHIR store at the given past timestamp. Runs the operation against the state of the store at this timestamp. State of the store is represented by the resource versions that were the current versions during the time specified or the resources that have not been updated since. Only works if the store has history enabled. Although users should be able to use this field to reproduce previous runs of the operation and get consistent results, there are a few cases where the past state of the store can be altered, thus resulting in no guarantee of reproducibility. For example, resource versions can be deleted using the purge method, or modified using ImportResourcesHistory.
+  "fhirpathQuery": { # A set of FHIRPath expressions that are used to filter the FHIR resources. These expressions do not maintain referential integrity on the resulting resources. Users are responsible for making sure the expressions are written in a way to ensure that if desired. # Return resources that match the specified FHIRPath expressions.
+    "engineVersion": "A String", # Optional. FHIRPath engine version number, for example "1.0". Will use the latest version if not specified. For more details about the supported versions, see https://cloud.google.com/healthcare-api/private/docs/how-tos/fhir-execute-cohort#fhirpath-engine-versions.
+    "expressions": [ # Required. List of FHIRPath expressions used for filtering the data.
+      { # A FHIRPath expression.
+        "fhirpathExpression": "A String", # Required. FHIRPath expression used for evaluation against FHIR resources. Must be in the format `[/"Resource"/"DomainResource"].[expression]` Expressions are applied per single FHIR resource, so they can't span multiple base resource types. For example, expressions like `Patient.union(Encounter)` are invalid. For expressions involving more than one resource or resource type, consider using the FHIRPath `resolve()` method. Expressions are only allowed to evaluate to a boolean type or a single or collection of [FHIR.Resource](https://hl7.org/fhir/resource.html) types. Expressions evaluating to boolean would include the base resource in the result if the expression evaluates to `true`. Expressions evaluating to one or more FHIR.Resource types will include those resources in the result, e.g. `CareTeam.member.resolve()`.
+        "label": "A String", # Optional. Expressions with the same label will be grouped together under the same directory when exporting to Cloud Storage.
+      },
+    ],
+  },
+  "gcsDestination": { # The configuration for exporting to Cloud Storage. # The Cloud Storage output destination. The Healthcare Service Agent account requires the `roles/storage.objectAdmin` role on the Cloud Storage location. The exported outputs are organized by FHIR resource types. The server creates one or more objects per resource type depending on the volume of the resources exported. When there is only one object per resource type, the object name is in the form of `{operation_id}_{resource_type}`. When there are multiple objects for a given resource type, the object names are in the form of `{operation_id}_{resource_type}-{index}-of-{total}`. Each object contains newline delimited JSON, and each line is a FHIR resource.
+    "uriPrefix": "A String", # URI for a Cloud Storage directory where result files should be written (in the format `gs://{bucket-id}/{path/to/destination/dir}`). If there is no trailing slash, the service appends one when composing the object path. The Cloud Storage bucket referenced in `uri_prefix` must exist or an error occurs.
+  },
+  "validateOnly": True or False, # Optional. If true, the request will be validated but no cohort execution will be run.
+}
+
+  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.
+  },
+}
+
+
explainDataAccess(name, resourceId=None, x__xgafv=None)
Explains all the permitted/denied actor, purpose and environment for a given resource. FHIR Consent is not supported in DSTU2 or R5.
diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1.json b/googleapiclient/discovery_cache/documents/healthcare.v1.json
index d9e8f8266b..3b329ba36d 100644
--- a/googleapiclient/discovery_cache/documents/healthcare.v1.json
+++ b/googleapiclient/discovery_cache/documents/healthcare.v1.json
@@ -5171,7 +5171,7 @@
 }
 }
 },
-"revision": "20260908",
+"revision": "20260924",
 "rootUrl": "https://healthcare.googleapis.com/",
 "schemas": {
 "AccessDeterminationLogConfig": {
@@ -5634,7 +5634,7 @@
 "type": "string"
 },
 "validateOnly": {
-"description": "Optional. If set to true, the request will only perform a dry run. By default (once the behavior change is fully rolled out), this will default to true. During the transition period, the default depends on the Mendel flag status for the project.",
+"description": "Optional. If set to `true`, the request will only perform a dry run. By default this will default to `false`.",
 "type": "boolean"
 },
 "versionConfig": {
diff --git a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json
index 5951113360..81e33ee976 100644
--- a/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json
+++ b/googleapiclient/discovery_cache/documents/healthcare.v1beta1.json
@@ -3481,6 +3481,35 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"executeCohort": {
+"description": "Executes and materializes a cohort definition from a FHIR store. This method returns an Operation that can be used to track the status of the cohort execution by calling GetOperation. Immediate fatal errors appear in the error field, errors are also logged to Cloud Logging (see [Viewing error logs in Cloud Logging](https://cloud.google.com/healthcare/docs/how-tos/logging)). Otherwise, when the operation finishes, a detailed response of type ExecuteCohortResponse is returned in the response field. The metadata field type for this operation is OperationMetadata.",
+"flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:executeCohort",
+"httpMethod": "POST",
+"id": "healthcare.projects.locations.datasets.fhirStores.executeCohort",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "Required. The name of the FHIR store to query, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.",
+"location": "path",
+"pattern": "^projects/[^/]+/locations/[^/]+/datasets/[^/]+/fhirStores/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1beta1/{+name}:executeCohort",
+"request": {
+"$ref": "ExecuteCohortRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-healthcare",
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "explainDataAccess": {
 "description": "Explains all the permitted/denied actor, purpose and environment for a given resource. FHIR Consent is not supported in DSTU2 or R5.",
 "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/datasets/{datasetsId}/fhirStores/{fhirStoresId}:explainDataAccess",
@@ -5767,7 +5796,7 @@
 }
 }
 },
-"revision": "20260908",
+"revision": "20260924",
 "rootUrl": "https://healthcare.googleapis.com/",
 "schemas": {
 "AccessDeterminationLogConfig": {
@@ -6290,7 +6319,7 @@
 "type": "string"
 },
 "validateOnly": {
-"description": "Optional. If set to true, the request will only perform a dry run. By default (once the behavior change is fully rolled out), this will default to true. During the transition period, the default depends on the Mendel flag status for the project.",
+"description": "Optional. If set to `true`, the request will only perform a dry run. By default this will default to `false`.",
 "type": "boolean"
 },
 "versionConfig": {
@@ -7318,6 +7347,41 @@
 },
 "type": "object"
 },
+"ExecuteCohortRequest": {
+"description": "Request to execute a cohort definition from a FHIR store based on provided queries and sending the resulting subset of data to a specified sink.",
+"id": "ExecuteCohortRequest",
+"properties": {
+"_at": {
+"description": "Optional. If provided, the queried resources will represent the state of the FHIR store at the given past timestamp. Runs the operation against the state of the store at this timestamp. State of the store is represented by the resource versions that were the current versions during the time specified or the resources that have not been updated since. Only works if the store has history enabled. Although users should be able to use this field to reproduce previous runs of the operation and get consistent results, there are a few cases where the past state of the store can be altered, thus resulting in no guarantee of reproducibility. For example, resource versions can be deleted using the purge method, or modified using ImportResourcesHistory.",
+"format": "google-datetime",
+"type": "string"
+},
+"fhirpathQuery": {
+"$ref": "FHIRPathQuery",
+"description": "Return resources that match the specified FHIRPath expressions."
+},
+"gcsDestination": {
+"$ref": "GoogleCloudHealthcareV1beta1FhirGcsDestination",
+"description": "The Cloud Storage output destination. The Healthcare Service Agent account requires the `roles/storage.objectAdmin` role on the Cloud Storage location. The exported outputs are organized by FHIR resource types. The server creates one or more objects per resource type depending on the volume of the resources exported. When there is only one object per resource type, the object name is in the form of `{operation_id}_{resource_type}`. When there are multiple objects for a given resource type, the object names are in the form of `{operation_id}_{resource_type}-{index}-of-{total}`. Each object contains newline delimited JSON, and each line is a FHIR resource."
+},
+"validateOnly": {
+"description": "Optional. If true, the request will be validated but no cohort execution will be run.",
+"type": "boolean"
+}
+},
+"type": "object"
+},
+"ExecuteCohortResponse": {
+"description": "Response when ExecuteCohort operation finishes querying all resources and sends them to a sink destination. This structure will be included in the response when the operation finishes successfully.",
+"id": "ExecuteCohortResponse",
+"properties": {
+"fhirStore": {
+"description": "The name of the queried FHIR store, in the format `projects/{project_id}/locations/{location_id}/datasets/{dataset_id}/fhirStores/{fhir_store_id}`.",
+"type": "string"
+}
+},
+"type": "object"
+},
 "ExplainDataAccessConsentInfo": {
 "description": "The enforcing consent's metadata.",
 "id": "ExplainDataAccessConsentInfo",
@@ -7570,6 +7634,39 @@
 },
 "type": "object"
 },
+"Expression": {
+"description": "A FHIRPath expression.",
+"id": "Expression",
+"properties": {
+"fhirpathExpression": {
+"description": "Required. FHIRPath expression used for evaluation against FHIR resources. Must be in the format `[/\"Resource\"/\"DomainResource\"].[expression]` Expressions are applied per single FHIR resource, so they can't span multiple base resource types. For example, expressions like `Patient.union(Encounter)` are invalid. For expressions involving more than one resource or resource type, consider using the FHIRPath `resolve()` method. Expressions are only allowed to evaluate to a boolean type or a single or collection of [FHIR.Resource](https://hl7.org/fhir/resource.html) types. Expressions evaluating to boolean would include the base resource in the result if the expression evaluates to `true`. Expressions evaluating to one or more FHIR.Resource types will include those resources in the result, e.g. `CareTeam.member.resolve()`.",
+"type": "string"
+},
+"label": {
+"description": "Optional. Expressions with the same label will be grouped together under the same directory when exporting to Cloud Storage.",
+"type": "string"
+}
+},
+"type": "object"
+},
+"FHIRPathQuery": {
+"description": "A set of FHIRPath expressions that are used to filter the FHIR resources. These expressions do not maintain referential integrity on the resulting resources. Users are responsible for making sure the expressions are written in a way to ensure that if desired.",
+"id": "FHIRPathQuery",
+"properties": {
+"engineVersion": {
+"description": "Optional. FHIRPath engine version number, for example \"1.0\". Will use the latest version if not specified. For more details about the supported versions, see https://cloud.google.com/healthcare-api/private/docs/how-tos/fhir-execute-cohort#fhirpath-engine-versions.",
+"type": "string"
+},
+"expressions": {
+"description": "Required. List of FHIRPath expressions used for filtering the data.",
+"items": {
+"$ref": "Expression"
+},
+"type": "array"
+}
+},
+"type": "object"
+},
 "Feature": {
 "description": "A feature of an entity mention.",
 "id": "Feature",

From e79bc3744068e2b87e37bd55f61a37cdaad135e4 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 6 Oct 2026 07:25:38 +0000
Subject: [PATCH 25/41] fix(hypercomputecluster): update the api

#### hypercomputecluster:v1

The following keys were changed:
- endpoints (Total Keys: 1)
---
 .../discovery_cache/documents/hypercomputecluster.v1.json  | 7 +------
 1 file changed, 1 insertion(+), 6 deletions(-)

diff --git a/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json b/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json
index d9e4296e73..55f8f8b244 100644
--- a/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json
+++ b/googleapiclient/discovery_cache/documents/hypercomputecluster.v1.json
@@ -33,11 +33,6 @@
 },
 {
 "description": "Regional Endpoint",
-"endpointUrl": "https://hypercomputecluster.us-east7.rep.googleapis.com/",
-"location": "us-east7"
-},
-{
-"description": "Regional Endpoint",
 "endpointUrl": "https://hypercomputecluster.us-south1.rep.googleapis.com/",
 "location": "us-south1"
 },
@@ -545,7 +540,7 @@
 }
 }
 },
-"revision": "20260918",
+"revision": "20260928",
 "rootUrl": "https://hypercomputecluster.googleapis.com/",
 "schemas": {
 "BootDisk": {

From 58942a19b88ad2494b7877a6208528a8182ca32a Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 6 Oct 2026 07:25:38 +0000
Subject: [PATCH 26/41] feat(iam): update the api

#### iam:v1

The following keys were added:
- resources.locations.resources.workforcePools.resources.subjects.methods.revokeSessions (Total Keys: 12)
- schemas.RevokeWorkforcePoolSubjectSessionsRequest (Total Keys: 2)
---
 ..._v1.locations.workforcePools.subjects.html | 44 +++++++++++++++++++
 .../discovery_cache/documents/iam.v1.json     | 36 ++++++++++++++-
 2 files changed, 79 insertions(+), 1 deletion(-)

diff --git a/docs/dyn/iam_v1.locations.workforcePools.subjects.html b/docs/dyn/iam_v1.locations.workforcePools.subjects.html
index c0b08e9e9b..90fa33418a 100644
--- a/docs/dyn/iam_v1.locations.workforcePools.subjects.html
+++ b/docs/dyn/iam_v1.locations.workforcePools.subjects.html
@@ -85,6 +85,9 @@ 

Instance Methods

delete(name, x__xgafv=None)

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.

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

Undeletes a WorkforcePoolSubject, as long as it was deleted fewer than 30 days ago.

@@ -129,6 +132,47 @@

Method Details

}
+
+ revokeSessions(name, body=None, x__xgafv=None) +
Revokes all sessions for a given WorkforcePoolSubject.
+
+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)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for RevokeWorkforcePoolSubjectSessions.
+}
+
+  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.
+  },
+}
+
+
undelete(name, body=None, x__xgafv=None)
Undeletes a WorkforcePoolSubject, as long as it was deleted fewer than 30 days ago.
diff --git a/googleapiclient/discovery_cache/documents/iam.v1.json b/googleapiclient/discovery_cache/documents/iam.v1.json
index 3b11493c6d..a8f959bf13 100644
--- a/googleapiclient/discovery_cache/documents/iam.v1.json
+++ b/googleapiclient/discovery_cache/documents/iam.v1.json
@@ -1333,6 +1333,34 @@
 "https://www.googleapis.com/auth/cloud-platform"
 ]
 },
+"revokeSessions": {
+"description": "Revokes all sessions for a given WorkforcePoolSubject.",
+"flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/subjects/{subjectsId}:revokeSessions",
+"httpMethod": "POST",
+"id": "iam.locations.workforcePools.subjects.revokeSessions",
+"parameterOrder": [
+"name"
+],
+"parameters": {
+"name": {
+"description": "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}`",
+"location": "path",
+"pattern": "^locations/[^/]+/workforcePools/[^/]+/subjects/[^/]+$",
+"required": true,
+"type": "string"
+}
+},
+"path": "v1/{+name}:revokeSessions",
+"request": {
+"$ref": "RevokeWorkforcePoolSubjectSessionsRequest"
+},
+"response": {
+"$ref": "Operation"
+},
+"scopes": [
+"https://www.googleapis.com/auth/cloud-platform"
+]
+},
 "undelete": {
 "description": "Undeletes a WorkforcePoolSubject, as long as it was deleted fewer than 30 days ago.",
 "flatPath": "v1/locations/{locationsId}/workforcePools/{workforcePoolsId}/subjects/{subjectsId}:undelete",
@@ -4341,7 +4369,7 @@
 }
 }
 },
-"revision": "20260918",
+"revision": "20260925",
 "rootUrl": "https://iam.googleapis.com/",
 "schemas": {
 "AccessRestrictions": {
@@ -5872,6 +5900,12 @@ false
 },
 "type": "object"
 },
+"RevokeWorkforcePoolSubjectSessionsRequest": {
+"description": "Request message for RevokeWorkforcePoolSubjectSessions.",
+"id": "RevokeWorkforcePoolSubjectSessionsRequest",
+"properties": {},
+"type": "object"
+},
 "Role": {
 "description": "A role in the Identity and Access Management API.",
 "id": "Role",

From 211f755ce19441905e761a72b071e364e47ea471 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 6 Oct 2026 07:25:38 +0000
Subject: [PATCH 27/41] feat(integrations): update the api

#### integrations:v1

The following keys were added:
- schemas.GoogleCloudConnectorsV1AdminFilters (Total Keys: 12)
- schemas.GoogleCloudConnectorsV1Connection.properties.adminFilters (Total Keys: 2)
- schemas.GoogleCloudConnectorsV1EventingConfig.properties.globalEventFilter.type (Total Keys: 1)
- schemas.GoogleCloudConnectorsV1EventingRuntimeDataWebhookData.properties.eventSubscriptions (Total Keys: 3)
- schemas.GoogleCloudConnectorsV1EventingRuntimeDataWebhookData.properties.eventTypes (Total Keys: 3)
- schemas.GoogleCloudIntegrationsV1alphaCustomerConfig.properties.enableEucHardenedFlow.type (Total Keys: 1)
- schemas.GoogleCloudIntegrationsV1alphaTestIntegrationsRequest.properties.asyncExecution.type (Total Keys: 1)
---
 docs/dyn/integrations_v1.html                 |   26 +-
 ...ons_v1.projects.locations.authConfigs.html |   18 +-
 ...ns_v1.projects.locations.certificates.html |   18 +-
 ...rations_v1.projects.locations.clients.html |    2 +
 ...ons_v1.projects.locations.connections.html |   46 +-
 ...ions.connections.runtimeActionSchemas.html |   18 +-
 ...ions.connections.runtimeEntitySchemas.html |   18 +-
 .../integrations_v1.projects.locations.html   |    1 +
 ...cts.locations.integrations.executions.html |   18 +-
 ...s.integrations.executions.suspensions.html |   18 +-
 ...ns_v1.projects.locations.integrations.html |   43 +-
 ...jects.locations.integrations.versions.html |   77 +-
 ...tions.integrations.versions.testCases.html |   18 +-
 ...ojects.locations.products.authConfigs.html |   18 +-
 ...jects.locations.products.certificates.html |   18 +-
 ...ions.products.integrations.executions.html |   18 +-
 ...s.integrations.executions.suspensions.html |   18 +-
 ...jects.locations.products.integrations.html |   25 +-
 ...ations.products.integrations.versions.html |   70 +-
 ...ects.locations.products.sfdcInstances.html |   18 +-
 ...s.products.sfdcInstances.sfdcChannels.html |   18 +-
 ...s_v1.projects.locations.sfdcInstances.html |   18 +-
 ....locations.sfdcInstances.sfdcChannels.html |   18 +-
 ...tions_v1.projects.locations.templates.html |  156 +-
 docs/dyn/integrations_v2.html                 |  111 +
 docs/dyn/integrations_v2.projects.html        |   91 +
 .../integrations_v2.projects.locations.html   |  346 ++
 ...cts.locations.integrations.executions.html |  230 ++
 ...ntegrations.executions.taskExecutions.html |  137 +
 ...ns_v2.projects.locations.integrations.html | 1101 +++++
 .../documents/integrations.v1.json            |  103 +-
 .../documents/integrations.v2.json            | 3586 +++++++++++++++++
 32 files changed, 6071 insertions(+), 350 deletions(-)
 create mode 100644 docs/dyn/integrations_v2.html
 create mode 100644 docs/dyn/integrations_v2.projects.html
 create mode 100644 docs/dyn/integrations_v2.projects.locations.html
 create mode 100644 docs/dyn/integrations_v2.projects.locations.integrations.executions.html
 create mode 100644 docs/dyn/integrations_v2.projects.locations.integrations.executions.taskExecutions.html
 create mode 100644 docs/dyn/integrations_v2.projects.locations.integrations.html
 create mode 100644 googleapiclient/discovery_cache/documents/integrations.v2.json

diff --git a/docs/dyn/integrations_v1.html b/docs/dyn/integrations_v1.html
index 8d0de665cc..8b5210fb1d 100644
--- a/docs/dyn/integrations_v1.html
+++ b/docs/dyn/integrations_v1.html
@@ -93,7 +93,7 @@ 

Instance Methods

close()

Close httplib2 connections.

- new_batch_http_request()

+ new_batch_http_request(callback=None)

Create a BatchHttpRequest object based on the discovery document.

Method Details

@@ -102,20 +102,20 @@

Method Details

- new_batch_http_request() + new_batch_http_request(callback=None)
Create a BatchHttpRequest object based on the discovery document.
 
-                Args:
-                  callback: callable, A callback to be called for each response, of the
-                    form callback(id, response, exception). The first parameter is the
-                    request id, and the second is the deserialized response object. The
-                    third is an apiclient.errors.HttpError exception object if an HTTP
-                    error occurred while processing the request, or None if no error
-                    occurred.
-
-                Returns:
-                  A BatchHttpRequest object based on the discovery document.
-                
+Args: + callback: callable, A callback to be called for each response, of the + form callback(id, response, exception). The first parameter is the + request id, and the second is the deserialized response object. The + third is an apiclient.errors.HttpError exception object if an HTTP + error occurred while processing the request, or None if no error + occurred. + +Returns: + A BatchHttpRequest object based on the discovery document. +
\ No newline at end of file diff --git a/docs/dyn/integrations_v1.projects.locations.authConfigs.html b/docs/dyn/integrations_v1.projects.locations.authConfigs.html index b5db7b2d17..caf9ef05f2 100644 --- a/docs/dyn/integrations_v1.projects.locations.authConfigs.html +++ b/docs/dyn/integrations_v1.projects.locations.authConfigs.html @@ -90,7 +90,7 @@

Instance Methods

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

Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(name, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, updateMask=None, x__xgafv=None)

@@ -1648,17 +1648,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
diff --git a/docs/dyn/integrations_v1.projects.locations.certificates.html b/docs/dyn/integrations_v1.projects.locations.certificates.html index f407f62bb4..e5d4652def 100644 --- a/docs/dyn/integrations_v1.projects.locations.certificates.html +++ b/docs/dyn/integrations_v1.projects.locations.certificates.html @@ -90,7 +90,7 @@

Instance Methods

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

List all the certificates that match the filter. Restrict to certificate of current client only.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -241,17 +241,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
diff --git a/docs/dyn/integrations_v1.projects.locations.clients.html b/docs/dyn/integrations_v1.projects.locations.clients.html index 81a9f03ac8..c211dcc062 100644 --- a/docs/dyn/integrations_v1.projects.locations.clients.html +++ b/docs/dyn/integrations_v1.projects.locations.clients.html @@ -120,6 +120,7 @@

Method Details

"kmsProjectId": "A String", # Optional. The gcp project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK "kmsRing": "A String", # Required. A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location. }, + "enableEucHardenedFlow": True or False, # Optional. True if every integration in this region should run under the hardened end-user-credential flow. See go/ip-euc-harden. "enableHttpCall": True or False, # Optional. Indicates if the client should be allowed to make HTTP calls. True if http call feature should be turned on for this region. "enableManagedAiFeatures": True or False, # Optional. Indicates if the client should be allowed to use managed AI features, i.e. using Cloud Companion APIs of the tenant project. This will allow the customers to use features like Troubleshooting, OpenAPI spec enrichment, etc. for free. "enableVariableMasking": True or False, # Optional. True if variable masking feature should be turned on for this region. @@ -145,6 +146,7 @@

Method Details

"kmsProjectId": "A String", # Optional. The gcp project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK "kmsRing": "A String", # Required. A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location. }, + "enableEucHardenedFlow": True or False, # Optional. True if every integration in this region should run under the hardened end-user-credential flow. See go/ip-euc-harden. "enableHttpCall": True or False, # Optional. Indicates if the client should be allowed to make HTTP calls. True if http call feature should be turned on for this region. "enableManagedAiFeatures": True or False, # Optional. Indicates if the client should be allowed to use managed AI features, i.e. using Cloud Companion APIs of the tenant project. This will allow the customers to use features like Troubleshooting, OpenAPI spec enrichment, etc. for free. "enableVariableMasking": True or False, # Optional. True if variable masking feature should be turned on for this region. diff --git a/docs/dyn/integrations_v1.projects.locations.connections.html b/docs/dyn/integrations_v1.projects.locations.connections.html index e1795d8a5d..f331fa39e6 100644 --- a/docs/dyn/integrations_v1.projects.locations.connections.html +++ b/docs/dyn/integrations_v1.projects.locations.connections.html @@ -94,7 +94,7 @@

Instance Methods

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

Lists Connections in a given project and location.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

@@ -147,6 +147,19 @@

Method Details

{ # Response containing Connections listed by region. "connections": [ # Connections. { # Connection represents an instance of connector. + "adminFilters": [ # Optional. Admin filters for the connection. These are used by Gemini Enterprise. + { # * AdminFilters defines a set of filters that can be applied to a connection. These are currently used by Gemini Enterprise connections. + "filterKey": "A String", # Required. Unique name for the filter, e.g., "SharePointSiteURL", "DocumentType", "ChatSpaceName". + "filterType": "A String", # Required. Type of the filter. + "intValue": "A String", # Optional. A single integer value. + "stringListValues": { # StringListValues is a message to store a list of string values. # Optional. List of string values. + "listValues": [ # Required. The list of string values. + "A String", + ], + }, + "stringValue": "A String", # Optional. A single string value. + }, + ], "asyncOperationsEnabled": True or False, # Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API. "authConfig": { # AuthConfig defines details of a authentication type. # Optional. Configuration for establishing the connection's authentication with an external system. "additionalVariables": [ # Optional. List containing additional auth configs. @@ -351,7 +364,7 @@

Method Details

"username": "A String", # Optional. Username. }, }, - "eventingConfig": { # Eventing Configuration of a connection next: 20 # Optional. Eventing config of a connection + "eventingConfig": { # Eventing Configuration of a connection next: 21 # Optional. Eventing config of a connection "additionalVariables": [ # Optional. Additional eventing related field values { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. "boolValue": True or False, # Optional. Value is a bool. @@ -451,6 +464,7 @@

Method Details

}, "enrichmentEnabled": True or False, # Optional. Enrichment Enabled. "eventsListenerIngressEndpoint": "A String", # Output only. Ingress endpoint of the event listener. This is used only when private connectivity is enabled. + "globalEventFilter": "A String", # Optional. Filter to be applied on the events to be received by the connection. "listenerAuthConfig": { # AuthConfig defines details of a authentication type. # Optional. Auth details for the event listener. "additionalVariables": [ # Optional. List containing additional auth configs. { # ConfigVariable represents a configuration variable present in a Connection. or AuthConfig. @@ -607,6 +621,12 @@

Method Details

}, ], "createTime": "A String", # Output only. Timestamp when the webhook was created. + "eventSubscriptions": [ # Output only. List of event subscriptions which are using the webhook. + "A String", + ], + "eventTypes": [ # Output only. List of event types for the webhook. This is the event types subscribed by the current webhook. + "A String", + ], "id": "A String", # Output only. ID to uniquely identify webhook. "name": "A String", # Output only. Name of the Webhook "nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported. @@ -631,6 +651,12 @@

Method Details

}, ], "createTime": "A String", # Output only. Timestamp when the webhook was created. + "eventSubscriptions": [ # Output only. List of event subscriptions which are using the webhook. + "A String", + ], + "eventTypes": [ # Output only. List of event types for the webhook. This is the event types subscribed by the current webhook. + "A String", + ], "id": "A String", # Output only. ID to uniquely identify webhook. "name": "A String", # Output only. Name of the Webhook "nextRefreshTime": "A String", # Output only. Next webhook refresh time. Will be null if refresh is not supported. @@ -717,17 +743,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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/integrations_v1.projects.locations.connections.runtimeActionSchemas.html b/docs/dyn/integrations_v1.projects.locations.connections.runtimeActionSchemas.html index dddfe1f1ad..0ea19d6353 100644 --- a/docs/dyn/integrations_v1.projects.locations.connections.runtimeActionSchemas.html +++ b/docs/dyn/integrations_v1.projects.locations.connections.runtimeActionSchemas.html @@ -81,7 +81,7 @@

Instance Methods

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

Lists the JSON schemas for the inputs and outputs of actions, filtered by action name.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

@@ -119,17 +119,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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/integrations_v1.projects.locations.connections.runtimeEntitySchemas.html b/docs/dyn/integrations_v1.projects.locations.connections.runtimeEntitySchemas.html index 59e1bde31b..88181754c8 100644 --- a/docs/dyn/integrations_v1.projects.locations.connections.runtimeEntitySchemas.html +++ b/docs/dyn/integrations_v1.projects.locations.connections.runtimeEntitySchemas.html @@ -81,7 +81,7 @@

Instance Methods

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

Lists the JSON schemas for the properties of runtime entities, filtered by entity name.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

@@ -119,17 +119,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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/integrations_v1.projects.locations.html b/docs/dyn/integrations_v1.projects.locations.html index 25f31b5b4d..9bb18987c4 100644 --- a/docs/dyn/integrations_v1.projects.locations.html +++ b/docs/dyn/integrations_v1.projects.locations.html @@ -207,6 +207,7 @@

Method Details

"kmsProjectId": "A String", # Optional. The gcp project id of the project where the kms key stored. If empty, the kms key is stored at the same project as customer's project and ecrypted with CMEK, otherwise, the kms key is stored in the tenant project and encrypted with GMEK "kmsRing": "A String", # Required. A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location. }, + "enableEucHardenedFlow": True or False, # Optional. True if every integration in this region should run under the hardened end-user-credential flow. See go/ip-euc-harden. "enableHttpCall": True or False, # Optional. Indicates if the client should be allowed to make HTTP calls. True if http call feature should be turned on for this region. "enableManagedAiFeatures": True or False, # Optional. Indicates if the client should be allowed to use managed AI features, i.e. using Cloud Companion APIs of the tenant project. This will allow the customers to use features like Troubleshooting, OpenAPI spec enrichment, etc. for free. "enableVariableMasking": True or False, # Optional. True if variable masking feature should be turned on for this region. diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.executions.html b/docs/dyn/integrations_v1.projects.locations.integrations.executions.html index cac8a043e0..00a5b6b119 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.executions.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.executions.html @@ -95,7 +95,7 @@

Instance Methods

list(parent, filter=None, filterParams_customFilter=None, filterParams_endTime=None, filterParams_eventStatuses=None, filterParams_executionId=None, filterParams_parameterKey=None, filterParams_parameterPairKey=None, filterParams_parameterPairValue=None, filterParams_parameterType=None, filterParams_parameterValue=None, filterParams_startTime=None, filterParams_taskStatuses=None, filterParams_workflowName=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, refreshAcl=None, snapshotMetadataWithoutParams=None, truncateParams=None, x__xgafv=None)

Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -1317,17 +1317,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
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 25cb1628c4..a0b6e95f70 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.executions.suspensions.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.executions.suspensions.html @@ -84,7 +84,7 @@

Instance Methods

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

* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -278,17 +278,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.html b/docs/dyn/integrations_v1.projects.locations.integrations.html index 097cd58b57..b15ea681ee 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.html @@ -100,7 +100,7 @@

Instance Methods

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

Returns the list of all integrations in the specified project.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -109,7 +109,7 @@

Instance Methods

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

Searches and returns the list of integrations in the specified project.

- search_next()

+ search_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -477,17 +477,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
@@ -681,17 +681,17 @@

Method Details

- search_next() + search_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)
+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.
-        
+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. +
@@ -704,6 +704,7 @@

Method Details

The object takes the form of: { # The request for testing an integration. + "asyncExecution": True or False, # Optional. Runs the test asynchronously, by enqueueing it through the real execution queue under `trigger_id` instead of running the task graph inline. Default `false`, which preserves the existing synchronous behavior. The enqueued request carries no caller identity, so it is drained under the integration's run-as service account, exactly as a real Cloud Scheduler, cron, Pub/Sub, Salesforce or connector fire would be. That is the only way to verify the credential path an asynchronous trigger actually takes; a synchronous test always carries the caller's own credential and so exercises the opposite branch. When `true`: * Only the **published** (`ACTIVE`) version runs. The asynchronous path resolves the integration from storage by `trigger_id`, so a draft cannot be tested this way. `integration_version` must therefore carry only `name`; supplying any other field is rejected, rather than silently running something other than what was passed. * The response carries `execution_id` only. `execution_failed`, `event_parameters`, `parameters` and `parameter_entries` describe a finished run and are left unset, because nothing has run yet. In particular, do not read `execution_failed` as a pass signal. * The run is real, with real side effects, quota and concurrency. No actual Pub/Sub push or Cloud Scheduler tick occurs; only the enqueue is simulated, which does not change the credential path. "clientId": "A String", # Required. This is used to identify the client on whose behalf the event will be executed. "configParameters": { # Optional. Config parameters used during integration execution. "a_key": "", # Properties of the object. @@ -883,7 +884,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -1088,7 +1089,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -1614,7 +1615,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.versions.html b/docs/dyn/integrations_v1.projects.locations.integrations.versions.html index 9b428a11e3..ae89f939f0 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.versions.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.versions.html @@ -101,7 +101,7 @@

Instance Methods

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

Returns the list of all integration versions in the specified project.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -278,7 +278,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -483,7 +483,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -1009,7 +1009,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -1331,7 +1331,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -1536,7 +1536,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -2062,7 +2062,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -2274,7 +2274,7 @@

Method Details

{ # Response for DownloadIntegrationVersion. "content": "A String", # String representation of the requested file. - "files": [ # List containing String represendation for multiple file with type. + "files": [ # List containing String representation for multiple file with type. { # To store string representation of Integration file. "content": "A String", # String representation of the file content. "file": "A String", # File information like Integration version, Integration Config variables etc. @@ -2453,7 +2453,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -2658,7 +2658,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -3184,7 +3184,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -3515,7 +3515,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -3720,7 +3720,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -4246,7 +4246,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -4580,7 +4580,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -4785,7 +4785,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -5311,7 +5311,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -5484,17 +5484,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
@@ -5651,7 +5651,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -5856,7 +5856,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -6382,7 +6382,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -6703,7 +6703,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -6908,7 +6908,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -7434,7 +7434,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -7639,6 +7639,7 @@

Method Details

The object takes the form of: { # The request for testing an integration. + "asyncExecution": True or False, # Optional. Runs the test asynchronously, by enqueueing it through the real execution queue under `trigger_id` instead of running the task graph inline. Default `false`, which preserves the existing synchronous behavior. The enqueued request carries no caller identity, so it is drained under the integration's run-as service account, exactly as a real Cloud Scheduler, cron, Pub/Sub, Salesforce or connector fire would be. That is the only way to verify the credential path an asynchronous trigger actually takes; a synchronous test always carries the caller's own credential and so exercises the opposite branch. When `true`: * Only the **published** (`ACTIVE`) version runs. The asynchronous path resolves the integration from storage by `trigger_id`, so a draft cannot be tested this way. `integration_version` must therefore carry only `name`; supplying any other field is rejected, rather than silently running something other than what was passed. * The response carries `execution_id` only. `execution_failed`, `event_parameters`, `parameters` and `parameter_entries` describe a finished run and are left unset, because nothing has run yet. In particular, do not read `execution_failed` as a pass signal. * The run is real, with real side effects, quota and concurrency. No actual Pub/Sub push or Cloud Scheduler tick occurs; only the enqueue is simulated, which does not change the credential path. "clientId": "A String", # Required. This is used to identify the client on whose behalf the event will be executed. "configParameters": { # Optional. Config parameters used during integration execution. "a_key": "", # Properties of the object. @@ -7818,7 +7819,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -8023,7 +8024,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -8549,7 +8550,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -8941,7 +8942,7 @@

Method Details

The object takes the form of: { # Request for UploadIntegrationVersion. - "content": "A String", # The textproto of the IntegrationVersion. + "content": "A String", # Optional. The textproto of the IntegrationVersion. "fileFormat": "A String", # File format for upload request. } @@ -9099,7 +9100,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -9304,7 +9305,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -9830,7 +9831,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. diff --git a/docs/dyn/integrations_v1.projects.locations.integrations.versions.testCases.html b/docs/dyn/integrations_v1.projects.locations.integrations.versions.testCases.html index 79391f029b..816d301307 100644 --- a/docs/dyn/integrations_v1.projects.locations.integrations.versions.testCases.html +++ b/docs/dyn/integrations_v1.projects.locations.integrations.versions.testCases.html @@ -99,7 +99,7 @@

Instance Methods

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

Lists all the test cases that satisfy the filters.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -1529,17 +1529,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
diff --git a/docs/dyn/integrations_v1.projects.locations.products.authConfigs.html b/docs/dyn/integrations_v1.projects.locations.products.authConfigs.html index bdaff6afc7..a3ab495920 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.authConfigs.html +++ b/docs/dyn/integrations_v1.projects.locations.products.authConfigs.html @@ -90,7 +90,7 @@

Instance Methods

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

Lists all auth configs that match the filter. Restrict to auth configs belong to the current client only.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

patch(name, body=None, clientCertificate_encryptedPrivateKey=None, clientCertificate_passphrase=None, clientCertificate_sslCertificate=None, updateMask=None, x__xgafv=None)

@@ -1648,17 +1648,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
diff --git a/docs/dyn/integrations_v1.projects.locations.products.certificates.html b/docs/dyn/integrations_v1.projects.locations.products.certificates.html index 6d1ba927fb..29eca699c5 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.certificates.html +++ b/docs/dyn/integrations_v1.projects.locations.products.certificates.html @@ -90,7 +90,7 @@

Instance Methods

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

List all the certificates that match the filter. Restrict to certificate of current client only.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -241,17 +241,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
diff --git a/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.html index d51e1e7c2f..43b20e2f78 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.html +++ b/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.html @@ -92,7 +92,7 @@

Instance Methods

list(parent, filter=None, filterParams_customFilter=None, filterParams_endTime=None, filterParams_eventStatuses=None, filterParams_executionId=None, filterParams_parameterKey=None, filterParams_parameterPairKey=None, filterParams_parameterPairValue=None, filterParams_parameterType=None, filterParams_parameterValue=None, filterParams_startTime=None, filterParams_taskStatuses=None, filterParams_workflowName=None, orderBy=None, pageSize=None, pageToken=None, readMask=None, refreshAcl=None, snapshotMetadataWithoutParams=None, truncateParams=None, x__xgafv=None)

Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

Method Details

@@ -1285,17 +1285,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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/integrations_v1.projects.locations.products.integrations.executions.suspensions.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.executions.suspensions.html index 6a1d37051f..072c1e0c4b 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 @@ -84,7 +84,7 @@

Instance Methods

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

* Lists suspensions associated with a specific execution. Only those with permissions to resolve the relevant suspensions will be able to view them.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -278,17 +278,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
diff --git a/docs/dyn/integrations_v1.projects.locations.products.integrations.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.html index ef612f1077..3565bf9076 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.integrations.html +++ b/docs/dyn/integrations_v1.projects.locations.products.integrations.html @@ -94,7 +94,7 @@

Instance Methods

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

Returns the list of all integrations in the specified project.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -426,17 +426,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
@@ -603,6 +603,7 @@

Method Details

The object takes the form of: { # The request for testing an integration. + "asyncExecution": True or False, # Optional. Runs the test asynchronously, by enqueueing it through the real execution queue under `trigger_id` instead of running the task graph inline. Default `false`, which preserves the existing synchronous behavior. The enqueued request carries no caller identity, so it is drained under the integration's run-as service account, exactly as a real Cloud Scheduler, cron, Pub/Sub, Salesforce or connector fire would be. That is the only way to verify the credential path an asynchronous trigger actually takes; a synchronous test always carries the caller's own credential and so exercises the opposite branch. When `true`: * Only the **published** (`ACTIVE`) version runs. The asynchronous path resolves the integration from storage by `trigger_id`, so a draft cannot be tested this way. `integration_version` must therefore carry only `name`; supplying any other field is rejected, rather than silently running something other than what was passed. * The response carries `execution_id` only. `execution_failed`, `event_parameters`, `parameters` and `parameter_entries` describe a finished run and are left unset, because nothing has run yet. In particular, do not read `execution_failed` as a pass signal. * The run is real, with real side effects, quota and concurrency. No actual Pub/Sub push or Cloud Scheduler tick occurs; only the enqueue is simulated, which does not change the credential path. "clientId": "A String", # Required. This is used to identify the client on whose behalf the event will be executed. "configParameters": { # Optional. Config parameters used during integration execution. "a_key": "", # Properties of the object. @@ -782,7 +783,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -987,7 +988,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -1513,7 +1514,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. diff --git a/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html b/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html index e0cad4a166..2e193b8168 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html +++ b/docs/dyn/integrations_v1.projects.locations.products.integrations.versions.html @@ -93,7 +93,7 @@

Instance Methods

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

Returns the list of all integration versions in the specified project.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -270,7 +270,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -475,7 +475,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -1001,7 +1001,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -1323,7 +1323,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -1528,7 +1528,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -2054,7 +2054,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -2266,7 +2266,7 @@

Method Details

{ # Response for DownloadIntegrationVersion. "content": "A String", # String representation of the requested file. - "files": [ # List containing String represendation for multiple file with type. + "files": [ # List containing String representation for multiple file with type. { # To store string representation of Integration file. "content": "A String", # String representation of the file content. "file": "A String", # File information like Integration version, Integration Config variables etc. @@ -2434,7 +2434,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -2639,7 +2639,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -3165,7 +3165,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -3499,7 +3499,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -3704,7 +3704,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -4230,7 +4230,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -4403,17 +4403,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
@@ -4570,7 +4570,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -4775,7 +4775,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -5301,7 +5301,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -5622,7 +5622,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -5827,7 +5827,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -6353,7 +6353,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -6714,7 +6714,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -6919,7 +6919,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -7445,7 +7445,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -7648,7 +7648,7 @@

Method Details

The object takes the form of: { # Request for UploadIntegrationVersion. - "content": "A String", # The textproto of the IntegrationVersion. + "content": "A String", # Optional. The textproto of the IntegrationVersion. "fileFormat": "A String", # File format for upload request. } @@ -7806,7 +7806,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -8011,7 +8011,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -8537,7 +8537,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. diff --git a/docs/dyn/integrations_v1.projects.locations.products.sfdcInstances.html b/docs/dyn/integrations_v1.projects.locations.products.sfdcInstances.html index 5095d9fcf4..a194de9d05 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.sfdcInstances.html +++ b/docs/dyn/integrations_v1.projects.locations.products.sfdcInstances.html @@ -95,7 +95,7 @@

Instance Methods

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

Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -238,17 +238,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
diff --git a/docs/dyn/integrations_v1.projects.locations.products.sfdcInstances.sfdcChannels.html b/docs/dyn/integrations_v1.projects.locations.products.sfdcInstances.sfdcChannels.html index 32a24662b2..d7d8aa6c2f 100644 --- a/docs/dyn/integrations_v1.projects.locations.products.sfdcInstances.sfdcChannels.html +++ b/docs/dyn/integrations_v1.projects.locations.products.sfdcInstances.sfdcChannels.html @@ -90,7 +90,7 @@

Instance Methods

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

Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -225,17 +225,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
diff --git a/docs/dyn/integrations_v1.projects.locations.sfdcInstances.html b/docs/dyn/integrations_v1.projects.locations.sfdcInstances.html index 7b4272b55a..2db24e501f 100644 --- a/docs/dyn/integrations_v1.projects.locations.sfdcInstances.html +++ b/docs/dyn/integrations_v1.projects.locations.sfdcInstances.html @@ -95,7 +95,7 @@

Instance Methods

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

Lists all sfdc instances that match the filter. Restrict to sfdc instances belonging to the current client only.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -238,17 +238,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
diff --git a/docs/dyn/integrations_v1.projects.locations.sfdcInstances.sfdcChannels.html b/docs/dyn/integrations_v1.projects.locations.sfdcInstances.sfdcChannels.html index ab4144f1cc..939810ffdf 100644 --- a/docs/dyn/integrations_v1.projects.locations.sfdcInstances.sfdcChannels.html +++ b/docs/dyn/integrations_v1.projects.locations.sfdcInstances.sfdcChannels.html @@ -90,7 +90,7 @@

Instance Methods

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

Lists all sfdc channels that match the filter. Restrict to sfdc channels belonging to the current client only.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -225,17 +225,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
diff --git a/docs/dyn/integrations_v1.projects.locations.templates.html b/docs/dyn/integrations_v1.projects.locations.templates.html index 443c577cbc..297d3fe2aa 100644 --- a/docs/dyn/integrations_v1.projects.locations.templates.html +++ b/docs/dyn/integrations_v1.projects.locations.templates.html @@ -96,7 +96,7 @@

Instance Methods

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

Lists all templates matching the filter.

- list_next()

+ list_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -105,7 +105,7 @@

Instance Methods

search(parent, enableNaturalLanguageQueryUnderstanding=None, filter=None, orderBy=None, pageSize=None, pageToken=None, query=None, readMask=None, x__xgafv=None)

Search templates based on user query and filters. This api would query the templates and return a list of templates based on the user filter.

- search_next()

+ search_next(previous_request, previous_response)

Retrieves the next page of results.

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

@@ -304,7 +304,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -509,7 +509,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -1035,7 +1035,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -1350,7 +1350,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -1555,7 +1555,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -2081,7 +2081,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -2435,7 +2435,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -2640,7 +2640,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -3166,7 +3166,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -3481,7 +3481,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -3686,7 +3686,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -4212,7 +4212,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -4615,7 +4615,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -4820,7 +4820,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -5346,7 +5346,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -5661,7 +5661,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -5866,7 +5866,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -6392,7 +6392,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -6742,7 +6742,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -6947,7 +6947,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -7473,7 +7473,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -7785,7 +7785,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -7990,7 +7990,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -8516,7 +8516,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -8878,7 +8878,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -9083,7 +9083,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -9609,7 +9609,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -9924,7 +9924,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -10129,7 +10129,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -10655,7 +10655,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -10835,17 +10835,17 @@

Method Details

- list_next() + 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)
+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.
-        
+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. +
@@ -11027,7 +11027,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -11232,7 +11232,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -11758,7 +11758,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -12073,7 +12073,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -12278,7 +12278,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -12804,7 +12804,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -13159,7 +13159,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -13364,7 +13364,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -13890,7 +13890,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -14205,7 +14205,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -14410,7 +14410,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -14936,7 +14936,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -15307,7 +15307,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -15512,7 +15512,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -16038,7 +16038,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -16353,7 +16353,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -16558,7 +16558,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -17084,7 +17084,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -17264,17 +17264,17 @@

Method Details

- search_next() + search_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)
+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.
-        
+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. +
@@ -17524,7 +17524,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -17729,7 +17729,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -18255,7 +18255,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -18570,7 +18570,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -18775,7 +18775,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -19301,7 +19301,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -19656,7 +19656,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -19861,7 +19861,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -20387,7 +20387,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. @@ -20699,7 +20699,7 @@

Method Details

"searchable": True or False, # Searchable in the execution log or not. }, ], - "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. + "integrationParametersInternal": { # LINT.IfChange This is the frontend version of WorkflowParameters. It's exactly like the backend version except that instead of flattening protobuf parameters and treating every field and subfield of a protobuf parameter as a separate parameter, the fields/subfields of a protobuf parameter will be nested as "children" (see 'children' field below) parameters of the parent parameter. Please refer to enterprise/crm/eventbus/proto/workflow_parameters.proto for more information about WorkflowParameters. # Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter. "parameters": [ # Parameters are a part of Event and can be used to communiticate between different tasks that are part of the same workflow execution. { "attributes": { # Attributes are additional options that can be associated with each event property. For more information, see # Metadata information about the parameters. @@ -20904,7 +20904,7 @@

Method Details

"taskTemplate": "A String", # Optional. Used to define task-template name if task is of type task-template }, ], - "taskConfigsInternal": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. + "taskConfigsInternal": [ # Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs. { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. "alertConfigs": [ # Alert configurations on error rate, warning rate, number of runs, durations, etc. { # Message to be used to configure alerting in the {@code TaskConfig} protos for tasks in an event. @@ -21430,7 +21430,7 @@

Method Details

"triggerType": "A String", # Optional. Type of trigger }, ], - "triggerConfigsInternal": [ # Optional. Trigger configurations. + "triggerConfigsInternal": [ # Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations. { # Configuration detail of a trigger. Next available id: 22 "alertConfig": [ # An alert threshold configuration for the [trigger + client + workflow] tuple. If these values are not specified in the trigger config, default values will be populated by the system. Note that there must be exactly one alert threshold configured per [client + trigger + workflow] when published. { # Message to be used to configure custom alerting in the {@code EventConfig} protos for an event. diff --git a/docs/dyn/integrations_v2.html b/docs/dyn/integrations_v2.html new file mode 100644 index 0000000000..fe948313db --- /dev/null +++ b/docs/dyn/integrations_v2.html @@ -0,0 +1,111 @@ + + + +

Application Integration API

+

Instance Methods

+

+ projects() +

+

Returns the projects Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ new_batch_http_request(callback=None)

+

Create a BatchHttpRequest object based on the discovery document.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ new_batch_http_request(callback=None) +
Create a BatchHttpRequest object based on the discovery document.
+
+Args:
+  callback: callable, A callback to be called for each response, of the
+    form callback(id, response, exception). The first parameter is the
+    request id, and the second is the deserialized response object. The
+    third is an apiclient.errors.HttpError exception object if an HTTP
+    error occurred while processing the request, or None if no error
+    occurred.
+
+Returns:
+  A BatchHttpRequest object based on the discovery document.
+
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v2.projects.html b/docs/dyn/integrations_v2.projects.html new file mode 100644 index 0000000000..4fdc2d210f --- /dev/null +++ b/docs/dyn/integrations_v2.projects.html @@ -0,0 +1,91 @@ + + + +

Application Integration API . projects

+

Instance Methods

+

+ locations() +

+

Returns the locations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

Method Details

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

Application Integration API . projects . locations

+

Instance Methods

+

+ integrations() +

+

Returns the integrations Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Generates an integration skeleton based on a natural language prompt.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ generateIntegration(parent, body=None, x__xgafv=None) +
Generates an integration skeleton based on a natural language prompt.
+
+Args:
+  parent: string, Required. The location in which the integration will be generated. Format: `projects/{project}/locations/{location}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request for generating an integration.
+  "copilotEnabled": True or False, # Optional. Indicates if copilot is enabled. Copilot features may alter the generated integration structure.
+  "prompt": "A String", # Required. The natural language prompt based on which the integration will be generated.
+}
+
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for generating an integration.
+  "skeletonIntegrations": [ # The list of integration skeletons returned.
+    { # An integration skeleton containing basic fields which can be used to create an integration on the UI.
+      "explanation": "A String", # Explanation of why this integration was generated.
+      "integrationVersion": { # The integration version definition. # The integration version containing basic triggers and tasks.
+        "description": "A String", # Optional. The integration description.
+        "errorCatcherConfigs": [ # Optional. Error Catch Task configuration for the integration. It's optional.
+          { # Configuration detail of a error catch task
+            "description": "A String", # Optional. User-provided description intended to give more business context about the error catcher config.
+            "errorCatcherId": "A String", # Required. An error catcher id is string representation for the error catcher config. Within a workflow, error_catcher_id uniquely identifies an error catcher config among all error catcher configs for the workflow
+            "errorCatcherNumber": "A String", # Required. A number to uniquely identify each error catcher config within the workflow on UI.
+            "label": "A String", # Optional. The user created label for a particular error catcher. Optional.
+            "startErrorTasks": [ # Required. The set of start tasks that are to be executed for the error catch flow
+              { # The task that is next in line to be executed, if the condition specified evaluated to true.
+                "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+                "description": "A String", # User-provided description intended to give additional business context about the task.
+                "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+                "taskConfigId": "A String", # ID of the next task.
+                "taskId": "A String", # Task number of the next task.
+              },
+            ],
+          },
+        ],
+        "integrationConfigParameters": [ # Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
+          { # Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes.
+            "parameter": { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition. # Optional. Integration Parameter to provide the default value, data type and attributes required for the Integration config variables.
+              "dataType": "A String", # Type of the parameter.
+              "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+              "description": "A String", # Optional. Description of the parameter.
+              "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+              "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+              "isTransient": True or False, # Whether this parameter is a transient parameter.
+              "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+            },
+            "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+              "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                "booleanValues": [ # Boolean array.
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False, # Boolean.
+              "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                "doubleValues": [ # Double number array.
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14, # Double Number.
+              "intArray": { # This message only contains a field of integer array. # Integer Array.
+                "intValues": [ # Integer array.
+                  "A String",
+                ],
+              },
+              "intValue": "A String", # Integer.
+              "jsonValue": "A String", # Json.
+              "stringArray": { # This message only contains a field of string array. # String Array.
+                "stringValues": [ # String array.
+                  "A String",
+                ],
+              },
+              "stringValue": "A String", # String.
+            },
+          },
+        ],
+        "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+          { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+            "dataType": "A String", # Type of the parameter.
+            "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+              "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                "booleanValues": [ # Boolean array.
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False, # Boolean.
+              "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                "doubleValues": [ # Double number array.
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14, # Double Number.
+              "intArray": { # This message only contains a field of integer array. # Integer Array.
+                "intValues": [ # Integer array.
+                  "A String",
+                ],
+              },
+              "intValue": "A String", # Integer.
+              "jsonValue": "A String", # Json.
+              "stringArray": { # This message only contains a field of string array. # String Array.
+                "stringValues": [ # String array.
+                  "A String",
+                ],
+              },
+              "stringValue": "A String", # String.
+            },
+            "description": "A String", # Optional. Description of the parameter.
+            "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+            "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+            "isTransient": True or False, # Whether this parameter is a transient parameter.
+            "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          },
+        ],
+        "name": "A String", # Optional. Auto-generated primary key.
+        "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+        "state": "A String", # Output only. User should not set it as an input.
+        "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+          { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+            "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+            "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+            "externalTaskType": "A String", # Optional. External task type of the task
+            "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+              { # The task that is next in line to be executed, if the condition specified evaluated to true.
+                "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+                "description": "A String", # User-provided description intended to give additional business context about the task.
+                "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+                "taskConfigId": "A String", # ID of the next task.
+                "taskId": "A String", # Task number of the next task.
+              },
+            ],
+            "parameters": { # Optional. The customized parameters the user can pass to this task.
+              "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+                "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+                "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                  "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                    "booleanValues": [ # Boolean array.
+                      True or False,
+                    ],
+                  },
+                  "booleanValue": True or False, # Boolean.
+                  "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                    "doubleValues": [ # Double number array.
+                      3.14,
+                    ],
+                  },
+                  "doubleValue": 3.14, # Double Number.
+                  "intArray": { # This message only contains a field of integer array. # Integer Array.
+                    "intValues": [ # Integer array.
+                      "A String",
+                    ],
+                  },
+                  "intValue": "A String", # Integer.
+                  "jsonValue": "A String", # Json.
+                  "stringArray": { # This message only contains a field of string array. # String Array.
+                    "stringValues": [ # String array.
+                      "A String",
+                    ],
+                  },
+                  "stringValue": "A String", # String.
+                },
+              },
+            },
+            "task": "A String", # Optional. The name for the task.
+            "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+          },
+        ],
+        "triggerConfigs": [ # Optional. Trigger configurations.
+          { # Configuration detail of a trigger.
+            "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+              "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+              "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+              "location": "A String", # Required. The location where associated cloud scheduler job will be created
+              "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+            },
+            "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+            "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+            "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
+              "names": [ # Optional. List of variable names.
+                "A String",
+              ],
+            },
+            "label": "A String", # Optional. The user created label for a particular trigger.
+            "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
+              "names": [ # Optional. List of variable names.
+                "A String",
+              ],
+            },
+            "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+              "a_key": "A String",
+            },
+            "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+              { # The task that is next in line to be executed, if the condition specified evaluated to true.
+                "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+                "description": "A String", # User-provided description intended to give additional business context about the task.
+                "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+                "taskConfigId": "A String", # ID of the next task.
+                "taskId": "A String", # Task number of the next task.
+              },
+            ],
+            "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
+            "triggerId": "A String", # Optional. The backend trigger ID.
+            "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+            "triggerType": "A String", # Optional. Type of trigger
+          },
+        ],
+        "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+      },
+      "name": "A String", # The name of the integration.
+      "tag": "A String", # Indicate the strategy/methodology used to generate the integration.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v2.projects.locations.integrations.executions.html b/docs/dyn/integrations_v2.projects.locations.integrations.executions.html new file mode 100644 index 0000000000..e803855d62 --- /dev/null +++ b/docs/dyn/integrations_v2.projects.locations.integrations.executions.html @@ -0,0 +1,230 @@ + + + +

Application Integration API . projects . locations . integrations . executions

+

Instance Methods

+

+ taskExecutions() +

+

Returns the taskExecutions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

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

+

Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.

+

+ list_next(previous_request, previous_response)

+

Retrieves the next page of results.

+

+ troubleshoot(name, x__xgafv=None)

+

View detailed explanation of why an integration execution failed, using LLM

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ list(parent, filter=None, pageSize=None, pageToken=None, readMask=None, x__xgafv=None) +
Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.
+
+Args:
+  parent: string, Required. parent resource name of integration execution. (required)
+  filter: string, Optional. Standard filter field, we support filtering on following fields: integration_name: the name of the integration. create_time: the execution created time. update_time: the execution last update time. state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. All fields support for EQUALS, in additional: create_time and update_time support for LESS_THAN, GREATER_THAN Also supports operators like AND, OR, NOT For example: trigger_id=\"id1\" AND integration_name=\"testIntegration\"
+  pageSize: integer, Optional. The size of entries in the response.
+  pageToken: string, Optional. The token returned in the previous response.
+  readMask: string, Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in execution info will be filled and returned.
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Response for listing the Integration executions.
+  "executions": [ # Required. The list of executions.
+    { # The Execution contains detailed information of an individual integration execution.
+      "cloudLoggingDetails": { # Cloud Logging details for execution info # Cloud Logging details for the integration version
+        "cloudLoggingSeverity": "A String", # Optional. Severity selected by the customer for the logs to be sent to Cloud Logging, for the integration version getting executed.
+        "enableCloudLogging": True or False, # Optional. Status of whether Cloud Logging is enabled or not for the integration version getting executed.
+      },
+      "containTaskVariables": True or False, # Indicates if the task execution contains variables.
+      "createTime": "A String", # Output only. Time the execution is created.
+      "executionAttemptStats": [ # Start and end time of each execution attempt.
+        { # Status for the execution attempt.
+          "endTime": "A String", # The end time of the execution for the current attempt.
+          "startTime": "A String", # The start time of the execution for the current attempt. This could be in the future if it's been scheduled.
+        },
+      ],
+      "integrationVersionNumber": "A String", # Indicates which snapshot of integration is used for this execution.
+      "integrationVersionUserLabel": "A String", # Optional. User-defined label that annotates the executed integration version.
+      "name": "A String", # Identifier. Execution resource name.
+      "replayInfo": { # Contains the details of the execution info: this includes the replay reason and replay tree connecting executions in a parent-child relationship # Output only. Replay info for the execution
+        "originalExecutionId": "A String", # If this execution is a replay of another execution, then this field contains the original execution id.
+        "replayMode": "A String", # Replay mode for the execution
+        "replayReason": "A String", # reason for replay
+        "replayedExecutionIds": [ # If this execution has been replayed, then this field contains the execution ids of the replayed executions.
+          "A String",
+        ],
+      },
+      "requestVariables": { # Optional. Variables provided in the request.
+        "a_key": "", # Properties of the object.
+      },
+      "responseVariables": { # Optional. Variables returned as part of the response.
+        "a_key": "", # Properties of the object.
+      },
+      "state": "A String", # Output only. Status of the execution.
+      "taskExecutions": [ # Optional. List of task executions.
+        { # Execution of a single task within an integration
+          "name": "A String", # Identifier. Task execution resource name.
+          "taskExecutionDetails": [ # Details of the task execution.
+            { # Details of the task execution.
+              "taskAttemptStats": [ # List for the current task execution attempts.
+                { # Status for the execution attempt.
+                  "endTime": "A String", # The end time of the execution for the current attempt.
+                  "startTime": "A String", # The start time of the execution for the current attempt. This could be in the future if it's been scheduled.
+                },
+              ],
+              "taskExecutionState": "A String", # Output only. The execution state of this task.
+              "taskNumber": "A String", # Pointer to the task config it used for execution.
+            },
+          ],
+          "taskExecutionMetadata": { # Metadata of the task execution. # Optional. Metadata of the task execution.
+            "ancestorIterationNumbers": [ # Optional. Ancestor iteration number for the task (it will only be non-empty if the task is under 'private integration').
+              "A String",
+            ],
+            "ancestorTaskNumbers": [ # Optional. Ancestor task number for the task (it will only be non-empty if the task is under 'private integration').
+              "A String",
+            ],
+            "executionAttempt": 42, # The execution attempt number this execution belongs to.
+            "privateIntegrationName": "A String", # Optional. The direct integration which the execution belongs to.
+            "task": "A String", # The task name associated with this execution.
+            "taskAttempt": 42, # The task attempt number this execution belongs to.
+            "taskLabel": "A String", # The task label associated with this execution.
+            "taskNumber": "A String", # The task number associated with this execution.
+          },
+          "variables": { # Optional. Variables used during the execution.
+            "a_key": "", # Properties of the object.
+          },
+        },
+      ],
+      "triggerId": "A String", # The ID of the trigger invoked at the start of the execution.
+      "updateTime": "A String", # Output only. Time the execution is recently updated.
+    },
+  ],
+  "nextPageToken": "A String", # The token for retrieving the next page of results.
+}
+
+ +
+ list_next(previous_request, previous_response) +
Retrieves the next page of results.
+
+Args:
+  previous_request: The request for the previous page. (required)
+  previous_response: The response from the request for the previous page. (required)
+
+Returns:
+  A request object that you can call 'execute()' on to request the next
+  page. Returns None if there are no more items in the collection.
+
+
+ +
+ troubleshoot(name, x__xgafv=None) +
View detailed explanation of why an integration execution failed, using LLM
+
+Args:
+  name: string, Required. Execution resource name. Format: `projects/{project}/locations/{location}/integrations/{integration}/executions/{execution_id}` (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 troubleshooting an integration execution.
+  "detailedExplanation": "A String", # Detailed explanation of the root cause of the integration execution failure.
+  "displayMessage": "A String", # Display message to be shown to the user. Example - If integration execution succeeded, this field value can be "Integration execution succeeded. No troubleshooting needed.".
+  "errorMessage": "A String", # Error message of the integration execution, if the execution failed.
+  "executionId": "A String", # The execution id of the integration execution to be troubleshooted.
+  "rootCause": "A String", # Root cause of the integration execution failure.
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v2.projects.locations.integrations.executions.taskExecutions.html b/docs/dyn/integrations_v2.projects.locations.integrations.executions.taskExecutions.html new file mode 100644 index 0000000000..095c1951c1 --- /dev/null +++ b/docs/dyn/integrations_v2.projects.locations.integrations.executions.taskExecutions.html @@ -0,0 +1,137 @@ + + + +

Application Integration API . projects . locations . integrations . executions . taskExecutions

+

Instance Methods

+

+ close()

+

Close httplib2 connections.

+

+ get(name, x__xgafv=None)

+

Get a TaskExecution in the specified project.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ get(name, x__xgafv=None) +
Get a TaskExecution in the specified project.
+
+Args:
+  name: string, Required. The TaskExecution to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/executions/{execution}/taskExecutions/{task_execution} (required)
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Execution of a single task within an integration
+  "name": "A String", # Identifier. Task execution resource name.
+  "taskExecutionDetails": [ # Details of the task execution.
+    { # Details of the task execution.
+      "taskAttemptStats": [ # List for the current task execution attempts.
+        { # Status for the execution attempt.
+          "endTime": "A String", # The end time of the execution for the current attempt.
+          "startTime": "A String", # The start time of the execution for the current attempt. This could be in the future if it's been scheduled.
+        },
+      ],
+      "taskExecutionState": "A String", # Output only. The execution state of this task.
+      "taskNumber": "A String", # Pointer to the task config it used for execution.
+    },
+  ],
+  "taskExecutionMetadata": { # Metadata of the task execution. # Optional. Metadata of the task execution.
+    "ancestorIterationNumbers": [ # Optional. Ancestor iteration number for the task (it will only be non-empty if the task is under 'private integration').
+      "A String",
+    ],
+    "ancestorTaskNumbers": [ # Optional. Ancestor task number for the task (it will only be non-empty if the task is under 'private integration').
+      "A String",
+    ],
+    "executionAttempt": 42, # The execution attempt number this execution belongs to.
+    "privateIntegrationName": "A String", # Optional. The direct integration which the execution belongs to.
+    "task": "A String", # The task name associated with this execution.
+    "taskAttempt": 42, # The task attempt number this execution belongs to.
+    "taskLabel": "A String", # The task label associated with this execution.
+    "taskNumber": "A String", # The task number associated with this execution.
+  },
+  "variables": { # Optional. Variables used during the execution.
+    "a_key": "", # Properties of the object.
+  },
+}
+
+ + \ No newline at end of file diff --git a/docs/dyn/integrations_v2.projects.locations.integrations.html b/docs/dyn/integrations_v2.projects.locations.integrations.html new file mode 100644 index 0000000000..e4f64366e4 --- /dev/null +++ b/docs/dyn/integrations_v2.projects.locations.integrations.html @@ -0,0 +1,1101 @@ + + + +

Application Integration API . projects . locations . integrations

+

Instance Methods

+

+ executions() +

+

Returns the executions Resource.

+ +

+ close()

+

Close httplib2 connections.

+

+ execute(parent, body=None, requestId=None, triggerId=None, x__xgafv=None)

+

Executes integrations synchronously. The response is not returned until the requested execution is either fulfilled or experienced an error. Only one integration can be executed. Request format URL: https://integrations.googleapis.com/v2/projects/$PROJECT/locations/$LOCATION/integrations/$INTEGRATION_NAME:execute Request payload: (the entire payload is optional unless input variables need to be set.) {"variable1": "hello world", "variable2": 1, "variable3": {"my_json_key": "my json string value" }

+

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

+

Generates an integration branch.

+

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

+

Generates documentation for an integration version.

+

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

+

Generates Javascript code for data mapping.

+

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

+

Recommends tasks to replace a selected task.

+

+ schedule(parent, body=None, requestId=None, scheduleTime=None, triggerId=None, x__xgafv=None)

+

Schedules an integration for execution.

+

Method Details

+
+ close() +
Close httplib2 connections.
+
+ +
+ execute(parent, body=None, requestId=None, triggerId=None, x__xgafv=None) +
Executes integrations synchronously. The response is not returned until the requested execution is either fulfilled or experienced an error. Only one integration can be executed. Request format URL: https://integrations.googleapis.com/v2/projects/$PROJECT/locations/$LOCATION/integrations/$INTEGRATION_NAME:execute Request payload: (the entire payload is optional unless input variables need to be set.) {"variable1": "hello world", "variable2": 1, "variable3": {"my_json_key": "my json string value" }
+
+Args:
+  parent: string, Required. The integration resource name. (required)
+  body: object, The request body.
+  requestId: string, Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
+  triggerId: string, Required. The API trigger id associated with the integration. An integration can have multiple trigger_id. This field is required to disambiguate which trigger should be invoked.
+  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.
+    },
+  ],
+}
+
+ +
+ generateIntegrationBranch(parent, body=None, x__xgafv=None) +
Generates an integration branch.
+
+Args:
+  parent: string, Required. Format: `projects/{project}/locations/{location}/integrations/{integration}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for generating an integration branch containing tasks.
+  "integrationBranchRequest": { # The request for generating an integration branch. # Required. The integration branch request payload.
+    "branchCondition": "A String", # Optional. The condition for the particular branch which the user selected.
+    "integrationParameters": [ # Optional. A list of all the workflow parameters of the current integration.
+      { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+        "dataType": "A String", # Type of the parameter.
+        "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+            "booleanValues": [ # Boolean array.
+              True or False,
+            ],
+          },
+          "booleanValue": True or False, # Boolean.
+          "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+            "doubleValues": [ # Double number array.
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14, # Double Number.
+          "intArray": { # This message only contains a field of integer array. # Integer Array.
+            "intValues": [ # Integer array.
+              "A String",
+            ],
+          },
+          "intValue": "A String", # Integer.
+          "jsonValue": "A String", # Json.
+          "stringArray": { # This message only contains a field of string array. # String Array.
+            "stringValues": [ # String array.
+              "A String",
+            ],
+          },
+          "stringValue": "A String", # String.
+        },
+        "description": "A String", # Optional. Description of the parameter.
+        "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter.
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      },
+    ],
+    "taskConfigs": [ # Required. A list of all the tasks of the current integration.
+      { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+        "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+        "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+        "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+        "externalTaskType": "A String", # Optional. External task type of the task
+        "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+        "parameters": { # Optional. The customized parameters the user can pass to this task.
+          "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+            "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                "booleanValues": [ # Boolean array.
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False, # Boolean.
+              "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                "doubleValues": [ # Double number array.
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14, # Double Number.
+              "intArray": { # This message only contains a field of integer array. # Integer Array.
+                "intValues": [ # Integer array.
+                  "A String",
+                ],
+              },
+              "intValue": "A String", # Integer.
+              "jsonValue": "A String", # Json.
+              "stringArray": { # This message only contains a field of string array. # String Array.
+                "stringValues": [ # String array.
+                  "A String",
+                ],
+              },
+              "stringValue": "A String", # String.
+            },
+          },
+        },
+        "task": "A String", # Optional. The name for the task.
+        "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      },
+    ],
+  },
+  "prompt": "A String", # Required. User prompt.
+}
+
+  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 generated integration branch data.
+  "integrationBranch": { # An integration branch skeleton containing basic fields which can be used to create an integration branch on the UI. # The integration branch returned by Duet
+    "branchCondition": "A String", # The condition for the branch.
+    "explanation": "A String", # Explanation of why this integration branch was generated.
+    "integrationParameters": [ # The newly generated workflow parameters.
+      { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+        "dataType": "A String", # Type of the parameter.
+        "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+          "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+            "booleanValues": [ # Boolean array.
+              True or False,
+            ],
+          },
+          "booleanValue": True or False, # Boolean.
+          "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+            "doubleValues": [ # Double number array.
+              3.14,
+            ],
+          },
+          "doubleValue": 3.14, # Double Number.
+          "intArray": { # This message only contains a field of integer array. # Integer Array.
+            "intValues": [ # Integer array.
+              "A String",
+            ],
+          },
+          "intValue": "A String", # Integer.
+          "jsonValue": "A String", # Json.
+          "stringArray": { # This message only contains a field of string array. # String Array.
+            "stringValues": [ # String array.
+              "A String",
+            ],
+          },
+          "stringValue": "A String", # String.
+        },
+        "description": "A String", # Optional. Description of the parameter.
+        "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+        "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+        "isTransient": True or False, # Whether this parameter is a transient parameter.
+        "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+        "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+      },
+    ],
+    "taskConfigs": [ # The newly generated tasks which can be branched into the current integration.
+      { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+        "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+        "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+        "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+        "externalTaskType": "A String", # Optional. External task type of the task
+        "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+        "parameters": { # Optional. The customized parameters the user can pass to this task.
+          "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+            "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                "booleanValues": [ # Boolean array.
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False, # Boolean.
+              "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                "doubleValues": [ # Double number array.
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14, # Double Number.
+              "intArray": { # This message only contains a field of integer array. # Integer Array.
+                "intValues": [ # Integer array.
+                  "A String",
+                ],
+              },
+              "intValue": "A String", # Integer.
+              "jsonValue": "A String", # Json.
+              "stringArray": { # This message only contains a field of string array. # String Array.
+                "stringValues": [ # String array.
+                  "A String",
+                ],
+              },
+              "stringValue": "A String", # String.
+            },
+          },
+        },
+        "task": "A String", # Optional. The name for the task.
+        "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      },
+    ],
+  },
+}
+
+ +
+ generateIntegrationDocument(parent, body=None, x__xgafv=None) +
Generates documentation for an integration version.
+
+Args:
+  parent: string, Required. Format: `projects/{project}/locations/{location}/integrations/{integration}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for generating documentation for an integration version.
+  "integrationDocumentRequest": { # The request for generating description of an integration. # Required. The integration document request payload.
+    "integrationVersion": { # The integration version definition. # Required. The current integrtion on the canvas.
+      "description": "A String", # Optional. The integration description.
+      "errorCatcherConfigs": [ # Optional. Error Catch Task configuration for the integration. It's optional.
+        { # Configuration detail of a error catch task
+          "description": "A String", # Optional. User-provided description intended to give more business context about the error catcher config.
+          "errorCatcherId": "A String", # Required. An error catcher id is string representation for the error catcher config. Within a workflow, error_catcher_id uniquely identifies an error catcher config among all error catcher configs for the workflow
+          "errorCatcherNumber": "A String", # Required. A number to uniquely identify each error catcher config within the workflow on UI.
+          "label": "A String", # Optional. The user created label for a particular error catcher. Optional.
+          "startErrorTasks": [ # Required. The set of start tasks that are to be executed for the error catch flow
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give additional business context about the task.
+              "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskId": "A String", # Task number of the next task.
+            },
+          ],
+        },
+      ],
+      "integrationConfigParameters": [ # Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
+        { # Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes.
+          "parameter": { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition. # Optional. Integration Parameter to provide the default value, data type and attributes required for the Integration config variables.
+            "dataType": "A String", # Type of the parameter.
+            "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+              "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                "booleanValues": [ # Boolean array.
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False, # Boolean.
+              "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                "doubleValues": [ # Double number array.
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14, # Double Number.
+              "intArray": { # This message only contains a field of integer array. # Integer Array.
+                "intValues": [ # Integer array.
+                  "A String",
+                ],
+              },
+              "intValue": "A String", # Integer.
+              "jsonValue": "A String", # Json.
+              "stringArray": { # This message only contains a field of string array. # String Array.
+                "stringValues": [ # String array.
+                  "A String",
+                ],
+              },
+              "stringValue": "A String", # String.
+            },
+            "description": "A String", # Optional. Description of the parameter.
+            "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+            "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+            "isTransient": True or False, # Whether this parameter is a transient parameter.
+            "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          },
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      ],
+      "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+        { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+          "dataType": "A String", # Type of the parameter.
+          "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+          "description": "A String", # Optional. Description of the parameter.
+          "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+          "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+          "isTransient": True or False, # Whether this parameter is a transient parameter.
+          "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+        },
+      ],
+      "name": "A String", # Optional. Auto-generated primary key.
+      "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+      "state": "A String", # Output only. User should not set it as an input.
+      "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+        { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+          "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+          "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+          "externalTaskType": "A String", # Optional. External task type of the task
+          "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give additional business context about the task.
+              "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskId": "A String", # Task number of the next task.
+            },
+          ],
+          "parameters": { # Optional. The customized parameters the user can pass to this task.
+            "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+            },
+          },
+          "task": "A String", # Optional. The name for the task.
+          "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+        },
+      ],
+      "triggerConfigs": [ # Optional. Trigger configurations.
+        { # Configuration detail of a trigger.
+          "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+            "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+            "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+            "location": "A String", # Required. The location where associated cloud scheduler job will be created
+            "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+          },
+          "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+          "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+          "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
+            "names": [ # Optional. List of variable names.
+              "A String",
+            ],
+          },
+          "label": "A String", # Optional. The user created label for a particular trigger.
+          "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
+            "names": [ # Optional. List of variable names.
+              "A String",
+            ],
+          },
+          "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+            "a_key": "A String",
+          },
+          "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give additional business context about the task.
+              "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskId": "A String", # Task number of the next task.
+            },
+          ],
+          "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
+          "triggerId": "A String", # Optional. The backend trigger ID.
+          "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+          "triggerType": "A String", # Optional. Type of trigger
+        },
+      ],
+      "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+    },
+  },
+}
+
+  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 generated integration documentation text.
+  "document": "A String", # The description of the integration returned by Duet AI.
+}
+
+ +
+ generateJavascript(parent, body=None, x__xgafv=None) +
Generates Javascript code for data mapping.
+
+Args:
+  parent: string, Required. Format: `projects/{project}/locations/{location}/integrations/{integration}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for generating data mapping Javascript.
+  "javascriptRequest": { # Request message for Javascript Task using Gemini. # Required. The javascript request payload.
+    "copilotEnabled": True or False, # Optional. If this request is for copilot.
+    "integrationVersion": { # The integration version definition. # Required. The integration version which contains all the integration parameters, all triggers and tasks including the Javascript task.
+      "description": "A String", # Optional. The integration description.
+      "errorCatcherConfigs": [ # Optional. Error Catch Task configuration for the integration. It's optional.
+        { # Configuration detail of a error catch task
+          "description": "A String", # Optional. User-provided description intended to give more business context about the error catcher config.
+          "errorCatcherId": "A String", # Required. An error catcher id is string representation for the error catcher config. Within a workflow, error_catcher_id uniquely identifies an error catcher config among all error catcher configs for the workflow
+          "errorCatcherNumber": "A String", # Required. A number to uniquely identify each error catcher config within the workflow on UI.
+          "label": "A String", # Optional. The user created label for a particular error catcher. Optional.
+          "startErrorTasks": [ # Required. The set of start tasks that are to be executed for the error catch flow
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give additional business context about the task.
+              "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskId": "A String", # Task number of the next task.
+            },
+          ],
+        },
+      ],
+      "integrationConfigParameters": [ # Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.
+        { # Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes.
+          "parameter": { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition. # Optional. Integration Parameter to provide the default value, data type and attributes required for the Integration config variables.
+            "dataType": "A String", # Type of the parameter.
+            "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+              "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                "booleanValues": [ # Boolean array.
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False, # Boolean.
+              "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                "doubleValues": [ # Double number array.
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14, # Double Number.
+              "intArray": { # This message only contains a field of integer array. # Integer Array.
+                "intValues": [ # Integer array.
+                  "A String",
+                ],
+              },
+              "intValue": "A String", # Integer.
+              "jsonValue": "A String", # Json.
+              "stringArray": { # This message only contains a field of string array. # String Array.
+                "stringValues": [ # String array.
+                  "A String",
+                ],
+              },
+              "stringValue": "A String", # String.
+            },
+            "description": "A String", # Optional. Description of the parameter.
+            "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+            "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+            "isTransient": True or False, # Whether this parameter is a transient parameter.
+            "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          },
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      ],
+      "integrationParameters": [ # Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.
+        { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+          "dataType": "A String", # Type of the parameter.
+          "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+          "description": "A String", # Optional. Description of the parameter.
+          "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+          "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+          "isTransient": True or False, # Whether this parameter is a transient parameter.
+          "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+        },
+      ],
+      "name": "A String", # Optional. Auto-generated primary key.
+      "snapshotNumber": "A String", # Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use "HEAD" tag to identify the head.
+      "state": "A String", # Output only. User should not set it as an input.
+      "taskConfigs": [ # Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.
+        { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+          "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+          "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+          "externalTaskType": "A String", # Optional. External task type of the task
+          "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give additional business context about the task.
+              "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskId": "A String", # Task number of the next task.
+            },
+          ],
+          "parameters": { # Optional. The customized parameters the user can pass to this task.
+            "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+              "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+              "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+                "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                  "booleanValues": [ # Boolean array.
+                    True or False,
+                  ],
+                },
+                "booleanValue": True or False, # Boolean.
+                "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                  "doubleValues": [ # Double number array.
+                    3.14,
+                  ],
+                },
+                "doubleValue": 3.14, # Double Number.
+                "intArray": { # This message only contains a field of integer array. # Integer Array.
+                  "intValues": [ # Integer array.
+                    "A String",
+                  ],
+                },
+                "intValue": "A String", # Integer.
+                "jsonValue": "A String", # Json.
+                "stringArray": { # This message only contains a field of string array. # String Array.
+                  "stringValues": [ # String array.
+                    "A String",
+                  ],
+                },
+                "stringValue": "A String", # String.
+              },
+            },
+          },
+          "task": "A String", # Optional. The name for the task.
+          "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+        },
+      ],
+      "triggerConfigs": [ # Optional. Trigger configurations.
+        { # Configuration detail of a trigger.
+          "cloudSchedulerConfig": { # Cloud Scheduler Trigger configuration # Optional. Cloud Scheduler Trigger related metadata
+            "cronTab": "A String", # Required. The cron tab of cloud scheduler trigger.
+            "errorMessage": "A String", # Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations
+            "location": "A String", # Required. The location where associated cloud scheduler job will be created
+            "serviceAccountEmail": "A String", # Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time
+          },
+          "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+          "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+          "inputVariables": { # Variables names mapped to api trigger. # Optional. List of input variables for the api trigger.
+            "names": [ # Optional. List of variable names.
+              "A String",
+            ],
+          },
+          "label": "A String", # Optional. The user created label for a particular trigger.
+          "outputVariables": { # Variables names mapped to api trigger. # Optional. List of output variables for the api trigger.
+            "names": [ # Optional. List of variable names.
+              "A String",
+            ],
+          },
+          "properties": { # Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. "name" is a property for API triggers and "subscription" is a property for Pub/sub triggers.
+            "a_key": "A String",
+          },
+          "startTasks": [ # Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).
+            { # The task that is next in line to be executed, if the condition specified evaluated to true.
+              "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+              "description": "A String", # User-provided description intended to give additional business context about the task.
+              "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+              "taskConfigId": "A String", # ID of the next task.
+              "taskId": "A String", # Task number of the next task.
+            },
+          ],
+          "trigger": "A String", # Optional. Name of the trigger. Example: "API Trigger", "Cloud Pub Sub Trigger" When set will be sent out to monitoring dashabord for tracking purpose.
+          "triggerId": "A String", # Optional. The backend trigger ID.
+          "triggerNumber": "A String", # Required. A number to uniquely identify each trigger config within the integration on UI.
+          "triggerType": "A String", # Optional. Type of trigger
+        },
+      ],
+      "userLabel": "A String", # Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.
+    },
+    "taskId": "A String", # Required. The task id of the Javascript task.
+    "useCurrentScript": True or False, # Optional. Whether to use the current javascript task config (JS code) to generate the Javascript code.
+  },
+  "prompt": "A String", # Optional. User prompt.
+}
+
+  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 generated Javascript code recommendations.
+  "recommendations": [ # List of the Javascript recommendations.
+    { # Individual Javascript recommendation containing the task config with the new code, integration parameters and the explanation.
+      "explanation": "A String", # The explanation of the Javascript code.
+      "integrationParameters": [ # Optional. The list of the new integration parameters.
+        { # Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.
+          "dataType": "A String", # Type of the parameter.
+          "defaultValue": { # The type of the parameter. # Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+          "description": "A String", # Optional. Description of the parameter.
+          "displayName": "A String", # The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is "foo.bar.myName", then the name would be "myName".
+          "inputOutputType": "A String", # Specifies the input/output type for the parameter.
+          "isTransient": True or False, # Whether this parameter is a transient parameter.
+          "jsonSchema": "A String", # This schema will be used to validate runtime JSON-typed values of this parameter.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+        },
+      ],
+      "taskConfig": { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. # Optional. The task config of the Javascript task.
+        "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+        "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+        "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+        "externalTaskType": "A String", # Optional. External task type of the task
+        "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+          { # The task that is next in line to be executed, if the condition specified evaluated to true.
+            "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+            "description": "A String", # User-provided description intended to give additional business context about the task.
+            "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+            "taskConfigId": "A String", # ID of the next task.
+            "taskId": "A String", # Task number of the next task.
+          },
+        ],
+        "parameters": { # Optional. The customized parameters the user can pass to this task.
+          "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+            "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+            "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+              "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+                "booleanValues": [ # Boolean array.
+                  True or False,
+                ],
+              },
+              "booleanValue": True or False, # Boolean.
+              "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+                "doubleValues": [ # Double number array.
+                  3.14,
+                ],
+              },
+              "doubleValue": 3.14, # Double Number.
+              "intArray": { # This message only contains a field of integer array. # Integer Array.
+                "intValues": [ # Integer array.
+                  "A String",
+                ],
+              },
+              "intValue": "A String", # Integer.
+              "jsonValue": "A String", # Json.
+              "stringArray": { # This message only contains a field of string array. # String Array.
+                "stringValues": [ # String array.
+                  "A String",
+                ],
+              },
+              "stringValue": "A String", # String.
+            },
+          },
+        },
+        "task": "A String", # Optional. The name for the task.
+        "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+      },
+    },
+  ],
+}
+
+ +
+ recommendTasks(parent, body=None, x__xgafv=None) +
Recommends tasks to replace a selected task.
+
+Args:
+  parent: string, Required. Format: `projects/{project}/locations/{location}/integrations/{integration}` (required)
+  body: object, The request body.
+    The object takes the form of:
+
+{ # Request message for recommending tasks to replace a selected task.
+  "prompt": "A String", # Optional. User prompt.
+  "replaceTaskRequest": { # Message for Replace Task Scenario. # Required. The current task to replace and options.
+    "copilotEnabled": True or False, # Optional. If this request is for copilot.
+    "taskConfig": { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task. # Required. The current task selected on the UI.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+      "externalTaskType": "A String", # Optional. External task type of the task
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+    },
+    "taskTypes": [ # The list of task types.
+      "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 recommended tasks for replacement.
+  "taskConfigs": [ # The list of recommended tasks.
+    { # The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.
+      "description": "A String", # Optional. User-provided description intended to give additional business context about the task.
+      "displayName": "A String", # Optional. User-provided label that is attached to this TaskConfig in the UI.
+      "errorCatcherId": "A String", # Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task
+      "externalTaskType": "A String", # Optional. External task type of the task
+      "nextTasks": [ # Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.
+        { # The task that is next in line to be executed, if the condition specified evaluated to true.
+          "condition": "A String", # Standard filter expression for this task to become an eligible next task.
+          "description": "A String", # User-provided description intended to give additional business context about the task.
+          "displayName": "A String", # User-provided label that is attached to this edge in the UI.
+          "taskConfigId": "A String", # ID of the next task.
+          "taskId": "A String", # Task number of the next task.
+        },
+      ],
+      "parameters": { # Optional. The customized parameters the user can pass to this task.
+        "a_key": { # This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.
+          "key": "A String", # Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.
+          "value": { # The type of the parameter. # Values for the defined keys. Each value can either be string, int, double or any proto message.
+            "booleanArray": { # This message only contains a field of boolean array. # Boolean Array.
+              "booleanValues": [ # Boolean array.
+                True or False,
+              ],
+            },
+            "booleanValue": True or False, # Boolean.
+            "doubleArray": { # This message only contains a field of double number array. # Double Number Array.
+              "doubleValues": [ # Double number array.
+                3.14,
+              ],
+            },
+            "doubleValue": 3.14, # Double Number.
+            "intArray": { # This message only contains a field of integer array. # Integer Array.
+              "intValues": [ # Integer array.
+                "A String",
+              ],
+            },
+            "intValue": "A String", # Integer.
+            "jsonValue": "A String", # Json.
+            "stringArray": { # This message only contains a field of string array. # String Array.
+              "stringValues": [ # String array.
+                "A String",
+              ],
+            },
+            "stringValue": "A String", # String.
+          },
+        },
+      },
+      "task": "A String", # Optional. The name for the task.
+      "taskId": "A String", # Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).
+    },
+  ],
+  "taskResponseStatuses": [ # The list of task response status based on the task_types in the request.
+    { # Message for task response status.
+      "errorMessage": "A String", # The error message of the task response in case of failure.
+      "httpCode": 42, # The http code of the task response.
+      "taskType": "A String", # The task type.
+    },
+  ],
+}
+
+ +
+ schedule(parent, body=None, requestId=None, scheduleTime=None, triggerId=None, x__xgafv=None) +
Schedules an integration for execution.
+
+Args:
+  parent: string, Required. The integration resource name. (required)
+  body: object, The request body.
+  requestId: string, Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.
+  scheduleTime: string, Optional. The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.
+  triggerId: string, Required. The API trigger id associated with the integration. An integration can have multiple trigger_id. This field is required to disambiguate which trigger should be invoked
+  x__xgafv: string, V1 error format.
+    Allowed values
+      1 - v1 error format
+      2 - v2 error format
+
+Returns:
+  An object of the form:
+
+    { # Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.
+  "contentType": "A String", # The HTTP Content-Type header value specifying the content type of the body.
+  "data": "A String", # The HTTP request/response body as raw binary.
+  "extensions": [ # Application specific response metadata. Must be set in the first response for streaming APIs.
+    {
+      "a_key": "", # Properties of the object. Contains field @type with type URL.
+    },
+  ],
+}
+
+ + \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/integrations.v1.json b/googleapiclient/discovery_cache/documents/integrations.v1.json index 688b304755..89e52602cb 100644 --- a/googleapiclient/discovery_cache/documents/integrations.v1.json +++ b/googleapiclient/discovery_cache/documents/integrations.v1.json @@ -4668,7 +4668,7 @@ } } }, -"revision": "20260225", +"revision": "20260927", "rootUrl": "https://integrations.googleapis.com/", "schemas": { "CrmlogErrorCode": { @@ -5909,7 +5909,7 @@ false ], "enumDescriptions": [ "", -"", +"WARNING: not the Apigee product. Marks external CUSTOMER traffic, including live Standalone IP clients, so deleting an `== APIGEE` branch breaks every external customer. SECURITY is the other external source (see ExternalTrafficUtils.EXTERNAL_SOURCES). Real Apigee test: !is_branded_as_standalone.", "" ], "type": "string" @@ -9314,6 +9314,58 @@ false }, "type": "object" }, +"GoogleCloudConnectorsV1AdminFilters": { +"description": "* AdminFilters defines a set of filters that can be applied to a connection. These are currently used by Gemini Enterprise connections.", +"id": "GoogleCloudConnectorsV1AdminFilters", +"properties": { +"filterKey": { +"description": "Required. Unique name for the filter, e.g., \"SharePointSiteURL\", \"DocumentType\", \"ChatSpaceName\".", +"type": "string" +}, +"filterType": { +"description": "Required. Type of the filter.", +"enum": [ +"FILTER_TYPE_UNSPECIFIED", +"INCLUSION", +"EXCLUSION" +], +"enumDescriptions": [ +"Filter type is not specified.", +"Only allow items matching the configured values.", +"Disallow items matching the configured values." +], +"type": "string" +}, +"intValue": { +"description": "Optional. A single integer value.", +"format": "int64", +"type": "string" +}, +"stringListValues": { +"$ref": "GoogleCloudConnectorsV1AdminFiltersStringListValues", +"description": "Optional. List of string values." +}, +"stringValue": { +"description": "Optional. A single string value.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudConnectorsV1AdminFiltersStringListValues": { +"description": "StringListValues is a message to store a list of string values.", +"id": "GoogleCloudConnectorsV1AdminFiltersStringListValues", +"properties": { +"listValues": { +"description": "Required. The list of string values.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "GoogleCloudConnectorsV1AuthConfig": { "description": "AuthConfig defines details of a authentication type.", "id": "GoogleCloudConnectorsV1AuthConfig", @@ -9589,6 +9641,13 @@ false "description": "Connection represents an instance of connector.", "id": "GoogleCloudConnectorsV1Connection", "properties": { +"adminFilters": { +"description": "Optional. Admin filters for the connection. These are used by Gemini Enterprise.", +"items": { +"$ref": "GoogleCloudConnectorsV1AdminFilters" +}, +"type": "array" +}, "asyncOperationsEnabled": { "description": "Optional. Async operations enabled for the connection. If Async Operations is enabled, Connection allows the customers to initiate async long running operations using the actions API.", "type": "boolean" @@ -10013,7 +10072,7 @@ false "type": "object" }, "GoogleCloudConnectorsV1EventingConfig": { -"description": "Eventing Configuration of a connection next: 20", +"description": "Eventing Configuration of a connection next: 21", "id": "GoogleCloudConnectorsV1EventingConfig", "properties": { "additionalVariables": { @@ -10051,6 +10110,10 @@ false "readOnly": true, "type": "string" }, +"globalEventFilter": { +"description": "Optional. Filter to be applied on the events to be received by the connection.", +"type": "string" +}, "listenerAuthConfig": { "$ref": "GoogleCloudConnectorsV1AuthConfig", "description": "Optional. Auth details for the event listener." @@ -10146,6 +10209,22 @@ false "readOnly": true, "type": "string" }, +"eventSubscriptions": { +"description": "Output only. List of event subscriptions which are using the webhook.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, +"eventTypes": { +"description": "Output only. List of event types for the webhook. This is the event types subscribed by the current webhook.", +"items": { +"type": "string" +}, +"readOnly": true, +"type": "array" +}, "id": { "description": "Output only. ID to uniquely identify webhook.", "readOnly": true, @@ -11259,6 +11338,10 @@ false "$ref": "GoogleCloudIntegrationsV1alphaCloudKmsConfig", "description": "Optional. Cloud KMS config for Auth Module to encrypt/decrypt credentials." }, +"enableEucHardenedFlow": { +"description": "Optional. True if every integration in this region should run under the hardened end-user-credential flow. See go/ip-euc-harden.", +"type": "boolean" +}, "enableHttpCall": { "description": "Optional. Indicates if the client should be allowed to make HTTP calls. True if http call feature should be turned on for this region.", "type": "boolean" @@ -11319,7 +11402,7 @@ false "type": "string" }, "files": { -"description": "List containing String represendation for multiple file with type.", +"description": "List containing String representation for multiple file with type.", "items": { "$ref": "GoogleCloudIntegrationsV1alphaSerializedFile" }, @@ -12420,7 +12503,7 @@ false "integrationParametersInternal": { "$ref": "EnterpriseCrmFrontendsEventbusProtoWorkflowParameters", "deprecated": true, -"description": "Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter." +"description": "Optional. Deprecated: Use `integration_parameters` instead. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter." }, "lastModifierEmail": { "description": "Optional. The last modifier's email address. Generated based on the End User Credentials/LOAS role of the user making the call.", @@ -12526,7 +12609,7 @@ false }, "taskConfigsInternal": { "deprecated": true, -"description": "Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.", +"description": "Optional. Deprecated: Use `task_configs` instead. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.", "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoTaskConfig" }, @@ -12546,7 +12629,7 @@ false }, "triggerConfigsInternal": { "deprecated": true, -"description": "Optional. Trigger configurations.", +"description": "Optional. Deprecated: Use `trigger_configs` instead. Trigger configurations.", "items": { "$ref": "EnterpriseCrmFrontendsEventbusProtoTriggerConfig" }, @@ -14497,6 +14580,10 @@ false "description": "The request for testing an integration.", "id": "GoogleCloudIntegrationsV1alphaTestIntegrationsRequest", "properties": { +"asyncExecution": { +"description": "Optional. Runs the test asynchronously, by enqueueing it through the real execution queue under `trigger_id` instead of running the task graph inline. Default `false`, which preserves the existing synchronous behavior. The enqueued request carries no caller identity, so it is drained under the integration's run-as service account, exactly as a real Cloud Scheduler, cron, Pub/Sub, Salesforce or connector fire would be. That is the only way to verify the credential path an asynchronous trigger actually takes; a synchronous test always carries the caller's own credential and so exercises the opposite branch. When `true`: * Only the **published** (`ACTIVE`) version runs. The asynchronous path resolves the integration from storage by `trigger_id`, so a draft cannot be tested this way. `integration_version` must therefore carry only `name`; supplying any other field is rejected, rather than silently running something other than what was passed. * The response carries `execution_id` only. `execution_failed`, `event_parameters`, `parameters` and `parameter_entries` describe a finished run and are left unset, because nothing has run yet. In particular, do not read `execution_failed` as a pass signal. * The run is real, with real side effects, quota and concurrency. No actual Pub/Sub push or Cloud Scheduler tick occurs; only the enqueue is simulated, which does not change the credential path.", +"type": "boolean" +}, "clientId": { "description": "Required. This is used to identify the client on whose behalf the event will be executed.", "type": "string" @@ -14768,7 +14855,7 @@ false "id": "GoogleCloudIntegrationsV1alphaUploadIntegrationVersionRequest", "properties": { "content": { -"description": "The textproto of the IntegrationVersion.", +"description": "Optional. The textproto of the IntegrationVersion.", "type": "string" }, "fileFormat": { diff --git a/googleapiclient/discovery_cache/documents/integrations.v2.json b/googleapiclient/discovery_cache/documents/integrations.v2.json new file mode 100644 index 0000000000..d418851b5d --- /dev/null +++ b/googleapiclient/discovery_cache/documents/integrations.v2.json @@ -0,0 +1,3586 @@ +{ +"auth": { +"oauth2": { +"scopes": { +"https://www.googleapis.com/auth/cloud-platform": { +"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." +} +} +} +}, +"basePath": "", +"baseUrl": "https://integrations.googleapis.com/", +"batchPath": "batch", +"canonicalName": "Integrations", +"description": "", +"discoveryVersion": "v1", +"documentationLink": "https://cloud.google.com/application-integration", +"fullyEncodeReservedExpansion": true, +"icons": { +"x16": "http://www.google.com/images/icons/product/search-16.gif", +"x32": "http://www.google.com/images/icons/product/search-32.gif" +}, +"id": "integrations:v2", +"kind": "discovery#restDescription", +"mtlsRootUrl": "https://integrations.mtls.googleapis.com/", +"name": "integrations", +"ownerDomain": "google.com", +"ownerName": "Google", +"parameters": { +"$.xgafv": { +"description": "V1 error format.", +"enum": [ +"1", +"2" +], +"enumDescriptions": [ +"v1 error format", +"v2 error format" +], +"location": "query", +"type": "string" +}, +"access_token": { +"description": "OAuth access token.", +"location": "query", +"type": "string" +}, +"alt": { +"default": "json", +"description": "Data format for response.", +"enum": [ +"json", +"media", +"proto" +], +"enumDescriptions": [ +"Responses with Content-Type of application/json", +"Media download with context-dependent Content-Type", +"Responses with Content-Type of application/x-protobuf" +], +"location": "query", +"type": "string" +}, +"callback": { +"description": "JSONP", +"location": "query", +"type": "string" +}, +"fields": { +"description": "Selector specifying which fields to include in a partial response.", +"location": "query", +"type": "string" +}, +"key": { +"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.", +"location": "query", +"type": "string" +}, +"oauth_token": { +"description": "OAuth 2.0 token for the current user.", +"location": "query", +"type": "string" +}, +"prettyPrint": { +"default": "true", +"description": "Returns response with indentations and line breaks.", +"location": "query", +"type": "boolean" +}, +"quotaUser": { +"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", +"location": "query", +"type": "string" +}, +"uploadType": { +"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", +"location": "query", +"type": "string" +}, +"upload_protocol": { +"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", +"location": "query", +"type": "string" +} +}, +"protocol": "rest", +"resources": { +"projects": { +"resources": { +"locations": { +"methods": { +"generateIntegration": { +"description": "Generates an integration skeleton based on a natural language prompt.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}:generateIntegration", +"httpMethod": "POST", +"id": "integrations.projects.locations.generateIntegration", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The location in which the integration will be generated. Format: `projects/{project}/locations/{location}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}:generateIntegration", +"request": { +"$ref": "GoogleCloudIntegrationsV2DuetGenerateIntegrationRequest" +}, +"response": { +"$ref": "GoogleCloudIntegrationsV2DuetGenerateIntegrationResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"integrations": { +"methods": { +"execute": { +"description": "Executes integrations synchronously. The response is not returned until the requested execution is either fulfilled or experienced an error. Only one integration can be executed. Request format URL: https://integrations.googleapis.com/v2/projects/$PROJECT/locations/$LOCATION/integrations/$INTEGRATION_NAME:execute Request payload: (the entire payload is optional unless input variables need to be set.) {\"variable1\": \"hello world\", \"variable2\": 1, \"variable3\": {\"my_json_key\": \"my json string value\" }", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:execute", +"httpMethod": "POST", +"id": "integrations.projects.locations.integrations.execute", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The integration resource name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.", +"location": "query", +"type": "string" +}, +"triggerId": { +"description": "Required. The API trigger id associated with the integration. An integration can have multiple trigger_id. This field is required to disambiguate which trigger should be invoked.", +"location": "query", +"type": "string" +} +}, +"path": "v2/{+parent}:execute", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generateIntegrationBranch": { +"description": "Generates an integration branch.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:generateIntegrationBranch", +"httpMethod": "POST", +"id": "integrations.projects.locations.integrations.generateIntegrationBranch", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Format: `projects/{project}/locations/{location}/integrations/{integration}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}:generateIntegrationBranch", +"request": { +"$ref": "GoogleCloudIntegrationsV2DuetGenerateIntegrationBranchRequest" +}, +"response": { +"$ref": "GoogleCloudIntegrationsV2DuetGenerateIntegrationBranchResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generateIntegrationDocument": { +"description": "Generates documentation for an integration version.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:generateIntegrationDocument", +"httpMethod": "POST", +"id": "integrations.projects.locations.integrations.generateIntegrationDocument", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Format: `projects/{project}/locations/{location}/integrations/{integration}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}:generateIntegrationDocument", +"request": { +"$ref": "GoogleCloudIntegrationsV2DuetGenerateIntegrationDocumentRequest" +}, +"response": { +"$ref": "GoogleCloudIntegrationsV2DuetGenerateIntegrationDocumentResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"generateJavascript": { +"description": "Generates Javascript code for data mapping.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:generateJavascript", +"httpMethod": "POST", +"id": "integrations.projects.locations.integrations.generateJavascript", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Format: `projects/{project}/locations/{location}/integrations/{integration}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}:generateJavascript", +"request": { +"$ref": "GoogleCloudIntegrationsV2DuetGenerateJavascriptRequest" +}, +"response": { +"$ref": "GoogleCloudIntegrationsV2DuetGenerateJavascriptResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"recommendTasks": { +"description": "Recommends tasks to replace a selected task.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:recommendTasks", +"httpMethod": "POST", +"id": "integrations.projects.locations.integrations.recommendTasks", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. Format: `projects/{project}/locations/{location}/integrations/{integration}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+parent}:recommendTasks", +"request": { +"$ref": "GoogleCloudIntegrationsV2DuetRecommendTasksRequest" +}, +"response": { +"$ref": "GoogleCloudIntegrationsV2DuetRecommendTasksResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"schedule": { +"description": "Schedules an integration for execution.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}:schedule", +"httpMethod": "POST", +"id": "integrations.projects.locations.integrations.schedule", +"parameterOrder": [ +"parent" +], +"parameters": { +"parent": { +"description": "Required. The integration resource name.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", +"required": true, +"type": "string" +}, +"requestId": { +"description": "Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned.", +"location": "query", +"type": "string" +}, +"scheduleTime": { +"description": "Optional. The time that the integration should be executed. If the time is less or equal to the current time, the integration is executed immediately.", +"format": "google-datetime", +"location": "query", +"type": "string" +}, +"triggerId": { +"description": "Required. The API trigger id associated with the integration. An integration can have multiple trigger_id. This field is required to disambiguate which trigger should be invoked", +"location": "query", +"type": "string" +} +}, +"path": "v2/{+parent}:schedule", +"request": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"type": "object" +}, +"response": { +"$ref": "GoogleApiHttpBody" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"executions": { +"methods": { +"list": { +"description": "Lists the results of all the integration executions. The response includes the same information as the [execution log](https://cloud.google.com/application-integration/docs/viewing-logs) in the Integration UI.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions", +"httpMethod": "GET", +"id": "integrations.projects.locations.integrations.executions.list", +"parameterOrder": [ +"parent" +], +"parameters": { +"filter": { +"description": "Optional. Standard filter field, we support filtering on following fields: integration_name: the name of the integration. create_time: the execution created time. update_time: the execution last update time. state: the state of the executions. execution_id: the id of the execution. trigger_id: the id of the trigger. All fields support for EQUALS, in additional: create_time and update_time support for LESS_THAN, GREATER_THAN Also supports operators like AND, OR, NOT For example: trigger_id=\\\"id1\\\" AND integration_name=\\\"testIntegration\\\"", +"location": "query", +"type": "string" +}, +"pageSize": { +"description": "Optional. The size of entries in the response.", +"format": "int32", +"location": "query", +"type": "integer" +}, +"pageToken": { +"description": "Optional. The token returned in the previous response.", +"location": "query", +"type": "string" +}, +"parent": { +"description": "Required. parent resource name of integration execution.", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+$", +"required": true, +"type": "string" +}, +"readMask": { +"description": "Optional. View mask for the response data. If set, only the field specified will be returned as part of the result. If not set, all fields in execution info will be filled and returned.", +"format": "google-fieldmask", +"location": "query", +"type": "string" +} +}, +"path": "v2/{+parent}/executions", +"response": { +"$ref": "GoogleCloudIntegrationsV2ListExecutionsResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +}, +"troubleshoot": { +"description": "View detailed explanation of why an integration execution failed, using LLM", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}:troubleshoot", +"httpMethod": "GET", +"id": "integrations.projects.locations.integrations.executions.troubleshoot", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. Execution resource name. Format: `projects/{project}/locations/{location}/integrations/{integration}/executions/{execution_id}`", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}:troubleshoot", +"response": { +"$ref": "GoogleCloudIntegrationsV2DuetTroubleshootExecutionResponse" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +}, +"resources": { +"taskExecutions": { +"methods": { +"get": { +"description": "Get a TaskExecution in the specified project.", +"flatPath": "v2/projects/{projectsId}/locations/{locationsId}/integrations/{integrationsId}/executions/{executionsId}/taskExecutions/{taskExecutionsId}", +"httpMethod": "GET", +"id": "integrations.projects.locations.integrations.executions.taskExecutions.get", +"parameterOrder": [ +"name" +], +"parameters": { +"name": { +"description": "Required. The TaskExecution to retrieve. Format: projects/{project}/locations/{location}/integrations/{integration}/executions/{execution}/taskExecutions/{task_execution}", +"location": "path", +"pattern": "^projects/[^/]+/locations/[^/]+/integrations/[^/]+/executions/[^/]+/taskExecutions/[^/]+$", +"required": true, +"type": "string" +} +}, +"path": "v2/{+name}", +"response": { +"$ref": "GoogleCloudIntegrationsV2TaskExecution" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform" +] +} +} +} +} +} +} +} +} +} +} +} +}, +"revision": "20260927", +"rootUrl": "https://integrations.googleapis.com/", +"schemas": { +"EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam": { +"id": "EnterpriseCrmEventbusAuthconfigAuthConfigTaskParam", +"properties": { +"allowedCredentialTypes": { +"description": "Defines the credential types to be supported as Task may restrict specific types to use, e.g. Cloud SQL Task will use username/password type only.", +"items": { +"enum": [ +"CREDENTIAL_TYPE_UNSPECIFIED", +"USERNAME_AND_PASSWORD", +"API_KEY", +"OAUTH2_AUTHORIZATION_CODE", +"OAUTH2_IMPLICIT", +"OAUTH2_CLIENT_CREDENTIALS", +"OAUTH2_RESOURCE_OWNER_CREDENTIALS", +"JWT", +"AUTH_TOKEN", +"SERVICE_ACCOUNT", +"CLIENT_CERTIFICATE_ONLY", +"OIDC_TOKEN" +], +"enumDescriptions": [ +"", +"Regular username/password pair.", +"API key.", +"OAuth 2.0 Authorization Code Grant Type.", +"OAuth 2.0 Implicit Grant Type.", +"OAuth 2.0 Client Credentials Grant Type.", +"OAuth 2.0 Resource Owner Credentials Grant Type.", +"JWT Token.", +"Auth Token, e.g. bearer token.", +"Service Account which can be used to generate token for authentication.", +"Client Certificate only.", +"Google OIDC ID Token" +], +"type": "string" +}, +"type": "array" +}, +"allowedServiceAccountInContext": { +"type": "boolean" +}, +"authConfigId": { +"description": "UUID of the AuthConfig.", +"type": "string" +}, +"scope": { +"description": "A space-delimited list of requested scope permissions.", +"type": "string" +}, +"useServiceAccountInContext": { +"type": "boolean" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoAddress": { +"description": "Email address along with optional name and tokens. These tokens will be substituted for the variables in the form of [{var_name}], where var_name could be any string of no more than 32 bytes.", +"id": "EnterpriseCrmEventbusProtoAddress", +"properties": { +"email": { +"description": "Required.", +"type": "string" +}, +"name": { +"type": "string" +}, +"tokens": { +"items": { +"$ref": "EnterpriseCrmEventbusProtoToken" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoBaseFunction": { +"id": "EnterpriseCrmEventbusProtoBaseFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"NOW_IN_MILLIS", +"INT_LIST", +"ENVIRONMENT", +"GET_EXECUTION_ID", +"GET_INTEGRATION_NAME", +"GET_REGION", +"GET_UUID", +"GET_PROJECT_ID" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoBaseValue": { +"id": "EnterpriseCrmEventbusProtoBaseValue", +"properties": { +"baseFunction": { +"$ref": "EnterpriseCrmEventbusProtoFunction", +"description": "Start with a function that does not build on existing values. Eg. CurrentTime, Min, Max, Exists, etc." +}, +"literalValue": { +"$ref": "EnterpriseCrmEventbusProtoParameterValueType", +"description": "Start with a literal value." +}, +"referenceValue": { +"description": "Start with a reference value to dereference.", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoBooleanArrayFunction": { +"id": "EnterpriseCrmEventbusProtoBooleanArrayFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"GET", +"APPEND", +"SIZE", +"TO_SET", +"APPEND_ALL", +"TO_JSON", +"SET", +"REMOVE", +"REMOVE_AT", +"CONTAINS", +"FOR_EACH", +"FILTER" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoBooleanFunction": { +"id": "EnterpriseCrmEventbusProtoBooleanFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"TO_JSON", +"NOT", +"AND", +"NAND", +"OR", +"XOR", +"NOR", +"XNOR", +"TO_STRING", +"EQUALS" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoBooleanParameterArray": { +"id": "EnterpriseCrmEventbusProtoBooleanParameterArray", +"properties": { +"booleanValues": { +"items": { +"type": "boolean" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoBuganizerNotification": { +"id": "EnterpriseCrmEventbusProtoBuganizerNotification", +"properties": { +"assigneeEmailAddress": { +"description": "Whom to assign the new bug. Optional.", +"type": "string" +}, +"componentId": { +"description": "ID of the buganizer component within which to create a new issue. Required.", +"format": "int64", +"type": "string" +}, +"templateId": { +"description": "ID of the buganizer template to use. Optional.", +"format": "int64", +"type": "string" +}, +"title": { +"description": "Title of the issue to be created. Required.", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoCloudKmsConfig": { +"id": "EnterpriseCrmEventbusProtoCloudKmsConfig", +"properties": { +"gcpProjectId": { +"description": "Optional. The id of GCP project where the KMS key is stored. If not provided, assume the key is stored in the same GCP project defined in Client (tag 14).", +"type": "string" +}, +"keyName": { +"description": "A Cloud KMS key is a named object containing one or more key versions, along with metadata for the key. A key exists on exactly one key ring tied to a specific location.", +"type": "string" +}, +"keyRingName": { +"description": "A key ring organizes keys in a specific Google Cloud location and allows you to manage access control on groups of keys. A key ring's name does not need to be unique across a Google Cloud project, but must be unique within a given location.", +"type": "string" +}, +"keyVersionName": { +"description": "Optional. Each version of a key contains key material used for encryption or signing. A key's version is represented by an integer, starting at 1. To decrypt data or verify a signature, you must use the same key version that was used to encrypt or sign the data.", +"type": "string" +}, +"locationName": { +"description": "Location name of the key ring, e.g. \"us-west1\".", +"type": "string" +}, +"serviceAccount": { +"description": "Optional. The service account used for authentication of this KMS key. If this is not provided, the service account in Client.clientSource will be used.", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoConnectorsConnection": { +"id": "EnterpriseCrmEventbusProtoConnectorsConnection", +"properties": { +"connectionName": { +"description": "Connection name Format: projects/{project}/locations/{location}/connections/{connection}", +"type": "string" +}, +"connectorVersion": { +"description": "Connector version Format: projects/{project}/locations/{location}/providers/{provider}/connectors/{connector}/versions/{version}", +"type": "string" +}, +"host": { +"description": "The name of the Hostname of the Service Directory service with TLS if used.", +"type": "string" +}, +"serviceName": { +"description": "Service name Format: projects/{project}/locations/{location}/namespaces/{namespace}/services/{service}", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig": { +"id": "EnterpriseCrmEventbusProtoConnectorsGenericConnectorTaskConfig", +"properties": { +"connection": { +"$ref": "EnterpriseCrmEventbusProtoConnectorsConnection", +"description": "User-selected connection." +}, +"operation": { +"description": "Operation to perform using the configured connection.", +"enum": [ +"OPERATION_UNSPECIFIED", +"EXECUTE_ACTION", +"LIST_ENTITIES", +"GET_ENTITY", +"CREATE_ENTITY", +"UPDATE_ENTITY", +"DELETE_ENTITY", +"EXECUTE_QUERY" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoCustomSuspensionRequest": { +"id": "EnterpriseCrmEventbusProtoCustomSuspensionRequest", +"properties": { +"postToQueueWithTriggerIdRequest": { +"$ref": "GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest", +"description": "Request to fire an event containing the SuspensionInfo message." +}, +"suspensionInfoEventParameterKey": { +"description": "In the fired event, set the SuspensionInfo message as the value for this key.", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoDoubleArrayFunction": { +"id": "EnterpriseCrmEventbusProtoDoubleArrayFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"GET", +"APPEND", +"SIZE", +"SUM", +"AVG", +"MAX", +"MIN", +"TO_SET", +"APPEND_ALL", +"TO_JSON", +"SET", +"REMOVE", +"REMOVE_AT", +"CONTAINS", +"FOR_EACH", +"FILTER" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoDoubleFunction": { +"id": "EnterpriseCrmEventbusProtoDoubleFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"TO_JSON", +"TO_STRING", +"ADD", +"SUBTRACT", +"MULTIPLY", +"DIVIDE", +"EXPONENT", +"ROUND", +"FLOOR", +"CEIL", +"GREATER_THAN", +"LESS_THAN", +"EQUALS", +"GREATER_THAN_EQUALS", +"LESS_THAN_EQUALS", +"MOD" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoDoubleParameterArray": { +"id": "EnterpriseCrmEventbusProtoDoubleParameterArray", +"properties": { +"doubleValues": { +"items": { +"format": "double", +"type": "number" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoEventParameters": { +"description": "LINT.IfChange This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus. Please see", +"id": "EnterpriseCrmEventbusProtoEventParameters", +"properties": { +"parameters": { +"description": "Parameters are a part of Event and can be used to communicate between different tasks that are part of the same integration execution.", +"items": { +"$ref": "EnterpriseCrmEventbusProtoParameterEntry" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoExecutionTraceInfo": { +"description": "Message that helps aggregate all sub-executions triggered by one execution and keeps track of child-parent relationships.", +"id": "EnterpriseCrmEventbusProtoExecutionTraceInfo", +"properties": { +"parentEventExecutionInfoId": { +"description": "Parent event execution info id that triggers the current execution through SubWorkflowExecutorTask.", +"type": "string" +}, +"traceId": { +"description": "Used to aggregate ExecutionTraceInfo.", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoExternalTraffic": { +"description": "Represents external traffic type and id.", +"id": "EnterpriseCrmEventbusProtoExternalTraffic", +"properties": { +"enableInternalIp": { +"description": "Indicates the client enables internal IP feature, this is applicable for internal clients only.", +"type": "boolean" +}, +"gcpProjectId": { +"description": "User\u2019s GCP project id the traffic is referring to.", +"type": "string" +}, +"gcpProjectNumber": { +"description": "User\u2019s GCP project number the traffic is referring to.", +"type": "string" +}, +"location": { +"description": "Location for the user's request.", +"type": "string" +}, +"retryRequestForQuota": { +"description": "Enqueue the execution request due to quota issue", +"type": "boolean" +}, +"source": { +"enum": [ +"SOURCE_UNSPECIFIED", +"APIGEE", +"SECURITY" +], +"enumDescriptions": [ +"", +"WARNING: not the Apigee product. Marks external CUSTOMER traffic, including live Standalone IP clients, so deleting an `== APIGEE` branch breaks every external customer. SECURITY is the other external source (see ExternalTrafficUtils.EXTERNAL_SOURCES). Real Apigee test: !is_branded_as_standalone.", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoField": { +"description": "Information about the value and type of the field.", +"id": "EnterpriseCrmEventbusProtoField", +"properties": { +"cardinality": { +"description": "By default, if the cardinality is unspecified the field is considered required while mapping.", +"enum": [ +"UNSPECIFIED", +"OPTIONAL" +], +"enumDescriptions": [ +"For fields with unspecified cardinality.", +"If field cardinality is set to optional, ignore errors if input field value is null or the reference_key is not found." +], +"type": "string" +}, +"defaultValue": { +"$ref": "EnterpriseCrmEventbusProtoParameterValueType", +"description": "This holds the default values for the fields. This value is supplied by user so may or may not contain PII or SPII data." +}, +"fieldType": { +"description": "Specifies the data type of the field.", +"enum": [ +"DATA_TYPE_UNSPECIFIED", +"STRING_VALUE", +"INT_VALUE", +"DOUBLE_VALUE", +"BOOLEAN_VALUE", +"PROTO_VALUE", +"SERIALIZED_OBJECT_VALUE", +"STRING_ARRAY", +"INT_ARRAY", +"DOUBLE_ARRAY", +"PROTO_ARRAY", +"PROTO_ENUM", +"BOOLEAN_ARRAY", +"PROTO_ENUM_ARRAY", +"BYTES", +"BYTES_ARRAY", +"NON_SERIALIZABLE_OBJECT", +"JSON_VALUE" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", +"", +"", +"" +], +"type": "string" +}, +"protoDefPath": { +"description": "Optional. The fully qualified proto name (e.g. enterprise.crm.storage.Account). Required for output field of type PROTO_VALUE or PROTO_ARRAY. For e.g., if input field_type is BYTES and output field_type is PROTO_VALUE, then fully qualified proto type url should be provided to parse the input bytes. If field_type is *_ARRAY, then all the converted protos are of the same type.", +"type": "string" +}, +"referenceKey": { +"description": "This holds the reference key of the workflow or task parameter. 1. Any workflow parameter, for e.g. $workflowParam1$. 2. Any task input or output parameter, for e.g. $task1_param1$. 3. Any workflow or task parameters with subfield references, for e.g., $task1_param1.employee.id$", +"type": "string" +}, +"transformExpression": { +"$ref": "EnterpriseCrmEventbusProtoTransformExpression", +"description": "This is the transform expression to fetch the input field value. for e.g. $param1$.CONCAT('test'). Keep points - 1. Only input field can have a transform expression. 2. If a transform expression is provided, reference_key will be ignored. 3. If no value is returned after evaluation of transform expression, default_value can be mapped if provided. 4. The field_type should be the type of the final object returned after the transform expression is evaluated. Scrubs the transform expression before logging as value provided by user so may or may not contain PII or SPII data." +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoFieldMappingConfig": { +"description": "Field Mapping Config to map multiple output fields values from input fields values.", +"id": "EnterpriseCrmEventbusProtoFieldMappingConfig", +"properties": { +"mappedFields": { +"items": { +"$ref": "EnterpriseCrmEventbusProtoMappedField" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoFunction": { +"id": "EnterpriseCrmEventbusProtoFunction", +"properties": { +"functionType": { +"$ref": "EnterpriseCrmEventbusProtoFunctionType", +"description": "The name of the function to perform." +}, +"parameters": { +"description": "List of parameters required for the transformation.", +"items": { +"$ref": "EnterpriseCrmEventbusProtoTransformExpression" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoFunctionType": { +"id": "EnterpriseCrmEventbusProtoFunctionType", +"properties": { +"baseFunction": { +"$ref": "EnterpriseCrmEventbusProtoBaseFunction", +"description": "LINT.IfChange" +}, +"booleanArrayFunction": { +"$ref": "EnterpriseCrmEventbusProtoBooleanArrayFunction" +}, +"booleanFunction": { +"$ref": "EnterpriseCrmEventbusProtoBooleanFunction" +}, +"doubleArrayFunction": { +"$ref": "EnterpriseCrmEventbusProtoDoubleArrayFunction" +}, +"doubleFunction": { +"$ref": "EnterpriseCrmEventbusProtoDoubleFunction" +}, +"intArrayFunction": { +"$ref": "EnterpriseCrmEventbusProtoIntArrayFunction" +}, +"intFunction": { +"$ref": "EnterpriseCrmEventbusProtoIntFunction" +}, +"jsonFunction": { +"$ref": "EnterpriseCrmEventbusProtoJsonFunction" +}, +"protoArrayFunction": { +"$ref": "EnterpriseCrmEventbusProtoProtoArrayFunction" +}, +"protoFunction": { +"$ref": "EnterpriseCrmEventbusProtoProtoFunction" +}, +"stringArrayFunction": { +"$ref": "EnterpriseCrmEventbusProtoStringArrayFunction" +}, +"stringFunction": { +"$ref": "EnterpriseCrmEventbusProtoStringFunction" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoIntArrayFunction": { +"id": "EnterpriseCrmEventbusProtoIntArrayFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"GET", +"APPEND", +"SIZE", +"SUM", +"AVG", +"MAX", +"MIN", +"TO_SET", +"APPEND_ALL", +"TO_JSON", +"SET", +"REMOVE", +"REMOVE_AT", +"CONTAINS", +"FOR_EACH", +"FILTER" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoIntFunction": { +"id": "EnterpriseCrmEventbusProtoIntFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"ADD", +"SUBTRACT", +"MULTIPLY", +"DIVIDE", +"EXPONENT", +"GREATER_THAN_EQUAL_TO", +"GREATER_THAN", +"LESS_THAN_EQUAL_TO", +"LESS_THAN", +"TO_DOUBLE", +"TO_STRING", +"EQUALS", +"TO_JSON", +"MOD", +"EPOCH_TO_HUMAN_READABLE_TIME" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoIntParameterArray": { +"id": "EnterpriseCrmEventbusProtoIntParameterArray", +"properties": { +"intValues": { +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoJsonFunction": { +"id": "EnterpriseCrmEventbusProtoJsonFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"GET_PROPERTY", +"GET_ELEMENT", +"APPEND_ELEMENT", +"SIZE", +"SET_PROPERTY", +"FLATTEN", +"FLATTEN_ONCE", +"MERGE", +"TO_STRING", +"TO_INT", +"TO_DOUBLE", +"TO_BOOLEAN", +"TO_PROTO", +"TO_STRING_ARRAY", +"TO_INT_ARRAY", +"TO_DOUBLE_ARRAY", +"TO_PROTO_ARRAY", +"TO_BOOLEAN_ARRAY", +"REMOVE_PROPERTY", +"RESOLVE_TEMPLATE", +"EQUALS", +"FOR_EACH", +"FILTER_ELEMENTS" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoLoopMetadata": { +"id": "EnterpriseCrmEventbusProtoLoopMetadata", +"properties": { +"currentIterationCount": { +"description": "Starting from 1, not 0.", +"format": "int64", +"type": "string" +}, +"currentIterationDetail": { +"description": "Needs to be set by the loop impl class before each iteration. The abstract loop class will append the request and response to it. Eg. The foreach Loop will clean up and set it as the current iteration element at the start of each loop. The post request and response will be appended to the value once they are available.", +"type": "string" +}, +"errorMsg": { +"description": "Add the error message when loops fail.", +"type": "string" +}, +"failureLocation": { +"description": "Indicates where in the loop logic did it error out.", +"enum": [ +"UNKNOWN", +"SUBWORKFLOW", +"PARAM_OVERRIDING", +"PARAM_AGGREGATING", +"SETTING_ITERATION_ELEMENT", +"GETTING_LIST_TO_ITERATE", +"CONDITION_EVALUATION", +"BUILDING_REQUEST" +], +"enumDescriptions": [ +"No error or Unknown.", +"Subworkflow failed while firing/running.", +"Param overrides failed.", +"Param aggregation failed.", +"Setting for loop current element failed.", +"Getting the list to iterate.", +"Evaluating the while loop condition.", +"Building the iteration request" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoMappedField": { +"description": "Mapped field is a pair of input field and output field.", +"id": "EnterpriseCrmEventbusProtoMappedField", +"properties": { +"inputField": { +"$ref": "EnterpriseCrmEventbusProtoField", +"description": "The input field being mapped from." +}, +"outputField": { +"$ref": "EnterpriseCrmEventbusProtoField", +"description": "The output field being mapped to." +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoNotification": { +"id": "EnterpriseCrmEventbusProtoNotification", +"properties": { +"buganizerNotification": { +"$ref": "EnterpriseCrmEventbusProtoBuganizerNotification" +}, +"emailAddress": { +"$ref": "EnterpriseCrmEventbusProtoAddress" +}, +"escalatorQueue": { +"type": "string" +}, +"pubsubTopic": { +"type": "string" +}, +"request": { +"$ref": "EnterpriseCrmEventbusProtoCustomSuspensionRequest", +"description": "If the out-of-the-box email/pubsub notifications are not suitable and custom logic is required, fire a workflow containing all info needed to notify users to resume execution." +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoParameterEntry": { +"description": "Key-value pair of EventBus parameters.", +"id": "EnterpriseCrmEventbusProtoParameterEntry", +"properties": { +"key": { +"description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.", +"type": "string" +}, +"masked": { +"description": "True if this parameter should be masked in the logs", +"type": "boolean" +}, +"value": { +"$ref": "EnterpriseCrmEventbusProtoParameterValueType", +"description": "Values for the defined keys. Each value can either be string, int, double or any proto message." +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoParameterMap": { +"description": "A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.", +"id": "EnterpriseCrmEventbusProtoParameterMap", +"properties": { +"entries": { +"items": { +"$ref": "EnterpriseCrmEventbusProtoParameterMapEntry" +}, +"type": "array" +}, +"keyType": { +"description": "Option to specify key value type for all entries of the map. If provided then field types for all entries must conform to this.", +"enum": [ +"DATA_TYPE_UNSPECIFIED", +"STRING_VALUE", +"INT_VALUE", +"DOUBLE_VALUE", +"BOOLEAN_VALUE", +"PROTO_VALUE", +"SERIALIZED_OBJECT_VALUE", +"STRING_ARRAY", +"INT_ARRAY", +"DOUBLE_ARRAY", +"PROTO_ARRAY", +"PROTO_ENUM", +"BOOLEAN_ARRAY", +"PROTO_ENUM_ARRAY", +"BYTES", +"BYTES_ARRAY", +"NON_SERIALIZABLE_OBJECT", +"JSON_VALUE" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", +"", +"", +"" +], +"type": "string" +}, +"valueType": { +"enum": [ +"DATA_TYPE_UNSPECIFIED", +"STRING_VALUE", +"INT_VALUE", +"DOUBLE_VALUE", +"BOOLEAN_VALUE", +"PROTO_VALUE", +"SERIALIZED_OBJECT_VALUE", +"STRING_ARRAY", +"INT_ARRAY", +"DOUBLE_ARRAY", +"PROTO_ARRAY", +"PROTO_ENUM", +"BOOLEAN_ARRAY", +"PROTO_ENUM_ARRAY", +"BYTES", +"BYTES_ARRAY", +"NON_SERIALIZABLE_OBJECT", +"JSON_VALUE" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoParameterMapEntry": { +"description": "Entry is a pair of key and value.", +"id": "EnterpriseCrmEventbusProtoParameterMapEntry", +"properties": { +"key": { +"$ref": "EnterpriseCrmEventbusProtoParameterMapField" +}, +"value": { +"$ref": "EnterpriseCrmEventbusProtoParameterMapField" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoParameterMapField": { +"description": "Field represents either the key or value in an entry.", +"id": "EnterpriseCrmEventbusProtoParameterMapField", +"properties": { +"literalValue": { +"$ref": "EnterpriseCrmEventbusProtoParameterValueType", +"description": "Passing a literal value." +}, +"referenceKey": { +"description": "Referencing one of the WF variables.", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoParameterValueType": { +"description": "LINT.IfChange To support various types of parameter values. Next available id: 14", +"id": "EnterpriseCrmEventbusProtoParameterValueType", +"properties": { +"booleanArray": { +"$ref": "EnterpriseCrmEventbusProtoBooleanParameterArray" +}, +"booleanValue": { +"type": "boolean" +}, +"doubleArray": { +"$ref": "EnterpriseCrmEventbusProtoDoubleParameterArray" +}, +"doubleValue": { +"format": "double", +"type": "number" +}, +"intArray": { +"$ref": "EnterpriseCrmEventbusProtoIntParameterArray" +}, +"intValue": { +"format": "int64", +"type": "string" +}, +"protoArray": { +"$ref": "EnterpriseCrmEventbusProtoProtoParameterArray" +}, +"protoValue": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"serializedObjectValue": { +"$ref": "EnterpriseCrmEventbusProtoSerializedObjectParameter" +}, +"stringArray": { +"$ref": "EnterpriseCrmEventbusProtoStringParameterArray" +}, +"stringValue": { +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoProtoArrayFunction": { +"id": "EnterpriseCrmEventbusProtoProtoArrayFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"GET", +"APPEND", +"SIZE", +"TO_SET", +"APPEND_ALL", +"TO_JSON", +"SET", +"REMOVE", +"REMOVE_AT", +"CONTAINS", +"FOR_EACH", +"FILTER" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoProtoFunction": { +"id": "EnterpriseCrmEventbusProtoProtoFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"GET_STRING_SUBFIELD", +"GET_INT_SUBFIELD", +"GET_DOUBLE_SUBFIELD", +"GET_BOOLEAN_SUBFIELD", +"GET_STRING_ARRAY_SUBFIELD", +"GET_INT_ARRAY_SUBFIELD", +"GET_DOUBLE_ARRAY_SUBFIELD", +"GET_BOOLEAN_ARRAY_SUBFIELD", +"GET_PROTO_ARRAY_SUBFIELD", +"GET_PROTO_SUBFIELD", +"TO_JSON", +"GET_BYTES_SUBFIELD_AS_UTF_8_STRING", +"GET_BYTES_SUBFIELD_AS_PROTO", +"EQUALS" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoProtoParameterArray": { +"id": "EnterpriseCrmEventbusProtoProtoParameterArray", +"properties": { +"protoValues": { +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoScatterResponse": { +"id": "EnterpriseCrmEventbusProtoScatterResponse", +"properties": { +"errorMsg": { +"description": "The error message of the failure if applicable.", +"type": "string" +}, +"executionIds": { +"description": "The execution ids of each Subworkflow fired by this scatter.", +"items": { +"type": "string" +}, +"type": "array" +}, +"isSuccessful": { +"description": "If execution is sync, this is true if the execution passed and false if it failed. If the execution is async, this is true if the WF was fired off successfully, and false if it failed to execute. The success or failure of the subworkflows executed are not captured.", +"type": "boolean" +}, +"responseParams": { +"description": "A list of all the response parameters in the aggregtorMap stored with the remapped key.", +"items": { +"$ref": "EnterpriseCrmEventbusProtoParameterEntry" +}, +"type": "array" +}, +"scatterElement": { +"$ref": "EnterpriseCrmEventbusProtoParameterValueType", +"description": "The element that was scattered for this execution." +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoSerializedObjectParameter": { +"id": "EnterpriseCrmEventbusProtoSerializedObjectParameter", +"properties": { +"objectValue": { +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoStringArrayFunction": { +"id": "EnterpriseCrmEventbusProtoStringArrayFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"GET", +"APPEND", +"SIZE", +"TO_SET", +"APPEND_ALL", +"TO_JSON", +"SET", +"REMOVE", +"REMOVE_AT", +"CONTAINS", +"FOR_EACH", +"FILTER" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoStringFunction": { +"id": "EnterpriseCrmEventbusProtoStringFunction", +"properties": { +"functionName": { +"enum": [ +"UNSPECIFIED", +"CONCAT", +"TO_UPPERCASE", +"TO_LOWERCASE", +"CONTAINS", +"SPLIT", +"LENGTH", +"EQUALS", +"TO_INT", +"TO_DOUBLE", +"TO_BOOLEAN", +"TO_BASE_64", +"TO_JSON", +"EQUALS_IGNORE_CASE", +"REPLACE_ALL", +"SUBSTRING", +"RESOLVE_TEMPLATE", +"DECODE_BASE64_STRING" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoStringParameterArray": { +"id": "EnterpriseCrmEventbusProtoStringParameterArray", +"properties": { +"stringValues": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoSuspensionAuthPermissions": { +"description": "LINT.IfChange", +"id": "EnterpriseCrmEventbusProtoSuspensionAuthPermissions", +"properties": { +"gaiaIdentity": { +"$ref": "EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity", +"description": "Represents a Gaia identity for a person or service account." +}, +"googleGroup": { +"$ref": "EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity" +}, +"loasRole": { +"type": "string" +}, +"mdbGroup": { +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity": { +"id": "EnterpriseCrmEventbusProtoSuspensionAuthPermissionsGaiaIdentity", +"properties": { +"emailAddress": { +"type": "string" +}, +"gaiaId": { +"format": "int64", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoSuspensionConfig": { +"id": "EnterpriseCrmEventbusProtoSuspensionConfig", +"properties": { +"customMessage": { +"description": "Optional information to provide recipients of the suspension in addition to the resolution URL, typically containing relevant parameter values from the originating workflow.", +"type": "string" +}, +"notifications": { +"items": { +"$ref": "EnterpriseCrmEventbusProtoNotification" +}, +"type": "array" +}, +"suspensionExpiration": { +"$ref": "EnterpriseCrmEventbusProtoSuspensionExpiration", +"description": "Indicates the next steps when no external actions happen on the suspension." +}, +"whoMayResolve": { +"description": "Identities able to resolve this suspension.", +"items": { +"$ref": "EnterpriseCrmEventbusProtoSuspensionAuthPermissions" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoSuspensionExpiration": { +"id": "EnterpriseCrmEventbusProtoSuspensionExpiration", +"properties": { +"expireAfterMs": { +"description": "Milliseconds after which the suspension expires, if no action taken.", +"format": "int32", +"type": "integer" +}, +"liftWhenExpired": { +"description": "Whether the suspension will be REJECTED or LIFTED upon expiration. REJECTED is the default behavior.", +"type": "boolean" +}, +"remindAfterMs": { +"description": "Milliseconds after which the previous suspension action reminder, if any, is sent using the selected notification option, for a suspension which is still PENDING_UNSPECIFIED.", +"format": "int32", +"type": "integer" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoSuspensionResolutionInfo": { +"id": "EnterpriseCrmEventbusProtoSuspensionResolutionInfo", +"properties": { +"audit": { +"$ref": "EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit" +}, +"clientId": { +"description": "The event data user sends as request.", +"type": "string" +}, +"cloudKmsConfig": { +"$ref": "EnterpriseCrmEventbusProtoCloudKmsConfig", +"description": "KMS info, used by cmek/gmek integration" +}, +"createdTimestamp": { +"description": "Auto-generated.", +"format": "google-datetime", +"type": "string" +}, +"encryptedSuspensionResolutionInfo": { +"description": "Encrypted SuspensionResolutionInfo", +"format": "byte", +"type": "string" +}, +"eventExecutionInfoId": { +"description": "Required. ID of the associated execution.", +"type": "string" +}, +"externalTraffic": { +"$ref": "EnterpriseCrmEventbusProtoExternalTraffic", +"description": "The origin of the suspension for periodic notifications." +}, +"lastModifiedTimestamp": { +"description": "Auto-generated.", +"format": "google-datetime", +"type": "string" +}, +"product": { +"description": "Which Google product the suspension belongs to. If not set, the suspension belongs to Integration Platform by default.", +"enum": [ +"UNSPECIFIED_PRODUCT", +"IP", +"APIGEE", +"SECURITY" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +}, +"status": { +"enum": [ +"PENDING_UNSPECIFIED", +"REJECTED", +"LIFTED", +"CANCELED" +], +"enumDescriptions": [ +"", +"", +"", +"" +], +"type": "string" +}, +"suspensionConfig": { +"$ref": "EnterpriseCrmEventbusProtoSuspensionConfig" +}, +"suspensionId": { +"description": "Primary key for the SuspensionResolutionInfoTable.", +"type": "string" +}, +"taskNumber": { +"description": "Required. Task number of the associated SuspensionTask.", +"type": "string" +}, +"workflowName": { +"description": "Required. The name of the originating workflow.", +"type": "string" +}, +"wrappedDek": { +"description": "Wrapped dek", +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit": { +"id": "EnterpriseCrmEventbusProtoSuspensionResolutionInfoAudit", +"properties": { +"resolvedBy": { +"type": "string" +}, +"resolvedByCpi": { +"type": "string" +}, +"timestamp": { +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoToken": { +"id": "EnterpriseCrmEventbusProtoToken", +"properties": { +"name": { +"type": "string" +}, +"value": { +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmEventbusProtoTransformExpression": { +"id": "EnterpriseCrmEventbusProtoTransformExpression", +"properties": { +"initialValue": { +"$ref": "EnterpriseCrmEventbusProtoBaseValue", +"description": "Initial value upon which to perform transformations." +}, +"transformationFunctions": { +"description": "Transformations to be applied sequentially.", +"items": { +"$ref": "EnterpriseCrmEventbusProtoFunction" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray": { +"id": "EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray", +"properties": { +"booleanValues": { +"items": { +"type": "boolean" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray": { +"id": "EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray", +"properties": { +"doubleValues": { +"items": { +"format": "double", +"type": "number" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmFrontendsEventbusProtoIntParameterArray": { +"id": "EnterpriseCrmFrontendsEventbusProtoIntParameterArray", +"properties": { +"intValues": { +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmFrontendsEventbusProtoParameterMap": { +"description": "A generic multi-map that holds key value pairs. They keys and values can be of any type, unless specified.", +"id": "EnterpriseCrmFrontendsEventbusProtoParameterMap", +"properties": { +"entries": { +"items": { +"$ref": "EnterpriseCrmFrontendsEventbusProtoParameterMapEntry" +}, +"type": "array" +}, +"keyType": { +"description": "Option to specify key value type for all entries of the map. If provided then field types for all entries must conform to this.", +"enum": [ +"DATA_TYPE_UNSPECIFIED", +"STRING_VALUE", +"INT_VALUE", +"DOUBLE_VALUE", +"BOOLEAN_VALUE", +"PROTO_VALUE", +"SERIALIZED_OBJECT_VALUE", +"STRING_ARRAY", +"INT_ARRAY", +"DOUBLE_ARRAY", +"PROTO_ARRAY", +"PROTO_ENUM", +"BOOLEAN_ARRAY", +"PROTO_ENUM_ARRAY", +"BYTES", +"BYTES_ARRAY", +"NON_SERIALIZABLE_OBJECT", +"JSON_VALUE" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", +"", +"", +"" +], +"type": "string" +}, +"valueType": { +"enum": [ +"DATA_TYPE_UNSPECIFIED", +"STRING_VALUE", +"INT_VALUE", +"DOUBLE_VALUE", +"BOOLEAN_VALUE", +"PROTO_VALUE", +"SERIALIZED_OBJECT_VALUE", +"STRING_ARRAY", +"INT_ARRAY", +"DOUBLE_ARRAY", +"PROTO_ARRAY", +"PROTO_ENUM", +"BOOLEAN_ARRAY", +"PROTO_ENUM_ARRAY", +"BYTES", +"BYTES_ARRAY", +"NON_SERIALIZABLE_OBJECT", +"JSON_VALUE" +], +"enumDescriptions": [ +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"", +"BYTES and BYTES_ARRAY data types are not allowed for top-level params. They're only meant to support protobufs with BYTES (sub)fields.", +"", +"", +"" +], +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmFrontendsEventbusProtoParameterMapEntry": { +"description": "Entry is a pair of key and value.", +"id": "EnterpriseCrmFrontendsEventbusProtoParameterMapEntry", +"properties": { +"key": { +"$ref": "EnterpriseCrmFrontendsEventbusProtoParameterMapField" +}, +"value": { +"$ref": "EnterpriseCrmFrontendsEventbusProtoParameterMapField" +} +}, +"type": "object" +}, +"EnterpriseCrmFrontendsEventbusProtoParameterMapField": { +"description": "Field represents either the key or value in an entry.", +"id": "EnterpriseCrmFrontendsEventbusProtoParameterMapField", +"properties": { +"literalValue": { +"$ref": "EnterpriseCrmFrontendsEventbusProtoParameterValueType", +"description": "Passing a literal value." +}, +"referenceKey": { +"description": "Referencing one of the WF variables.", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmFrontendsEventbusProtoParameterValueType": { +"description": "To support various types of parameter values. Next available id: 14", +"id": "EnterpriseCrmFrontendsEventbusProtoParameterValueType", +"properties": { +"booleanArray": { +"$ref": "EnterpriseCrmFrontendsEventbusProtoBooleanParameterArray" +}, +"booleanValue": { +"type": "boolean" +}, +"doubleArray": { +"$ref": "EnterpriseCrmFrontendsEventbusProtoDoubleParameterArray" +}, +"doubleValue": { +"format": "double", +"type": "number" +}, +"intArray": { +"$ref": "EnterpriseCrmFrontendsEventbusProtoIntParameterArray" +}, +"intValue": { +"format": "int64", +"type": "string" +}, +"jsonValue": { +"type": "string" +}, +"protoArray": { +"$ref": "EnterpriseCrmFrontendsEventbusProtoProtoParameterArray" +}, +"protoValue": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"serializedObjectValue": { +"$ref": "EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter" +}, +"stringArray": { +"$ref": "EnterpriseCrmFrontendsEventbusProtoStringParameterArray" +}, +"stringValue": { +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmFrontendsEventbusProtoProtoParameterArray": { +"id": "EnterpriseCrmFrontendsEventbusProtoProtoParameterArray", +"properties": { +"protoValues": { +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, +"EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter": { +"id": "EnterpriseCrmFrontendsEventbusProtoSerializedObjectParameter", +"properties": { +"objectValue": { +"format": "byte", +"type": "string" +} +}, +"type": "object" +}, +"EnterpriseCrmFrontendsEventbusProtoStringParameterArray": { +"id": "EnterpriseCrmFrontendsEventbusProtoStringParameterArray", +"properties": { +"stringValues": { +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleApiHttpBody": { +"description": "Message that represents an arbitrary HTTP body. It should only be used for payload formats that can't be represented as JSON, such as raw binary or an HTML page. This message can be used both in streaming and non-streaming API methods in the request as well as the response. It can be used as a top-level request field, which is convenient if one wants to extract parameters from either the URL or HTTP template into the request fields and also want access to the raw HTTP body. Example: message GetResourceRequest { // A unique request id. string request_id = 1; // The raw HTTP body is bound to this field. google.api.HttpBody http_body = 2; } service ResourceService { rpc GetResource(GetResourceRequest) returns (google.api.HttpBody); rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty); } Example with streaming methods: service CaldavService { rpc GetCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); rpc UpdateCalendar(stream google.api.HttpBody) returns (stream google.api.HttpBody); } Use of this type only changes how the request and response bodies are handled, all other features will continue to work unchanged.", +"id": "GoogleApiHttpBody", +"properties": { +"contentType": { +"description": "The HTTP Content-Type header value specifying the content type of the body.", +"type": "string" +}, +"data": { +"description": "The HTTP request/response body as raw binary.", +"format": "byte", +"type": "string" +}, +"extensions": { +"description": "Application specific response metadata. Must be set in the first response for streaming APIs.", +"items": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"type": "object" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2AttemptStats": { +"description": "Status for the execution attempt.", +"id": "GoogleCloudIntegrationsV2AttemptStats", +"properties": { +"endTime": { +"description": "The end time of the execution for the current attempt.", +"format": "google-datetime", +"type": "string" +}, +"startTime": { +"description": "The start time of the execution for the current attempt. This could be in the future if it's been scheduled.", +"format": "google-datetime", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2CloudLoggingDetails": { +"description": "Cloud Logging details for execution info", +"id": "GoogleCloudIntegrationsV2CloudLoggingDetails", +"properties": { +"cloudLoggingSeverity": { +"description": "Optional. Severity selected by the customer for the logs to be sent to Cloud Logging, for the integration version getting executed.", +"enum": [ +"CLOUD_LOGGING_SEVERITY_UNSPECIFIED", +"INFO", +"ERROR", +"WARNING" +], +"enumDescriptions": [ +"Unspecified", +"If Severity selected is `INFO`, then all the Integration Execution States (`IN_PROCESS`, `ON_HOLD`, `SUCCEEDED`, `SUSPENDED`, `ERROR`, `CANCELLED`) will be sent to Cloud Logging.", +"If Severity selected is `ERROR`, then only the following Integration Execution States (`ERROR`, `CANCELLED`) will be sent to Cloud Logging.", +"If Severity selected is `WARNING`, then only the following Integration Execution States (`ERROR`, `CANCELLED`) will be sent to Cloud Logging." +], +"type": "string" +}, +"enableCloudLogging": { +"description": "Optional. Status of whether Cloud Logging is enabled or not for the integration version getting executed.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetBooleanParameterArray": { +"description": "This message only contains a field of boolean array.", +"id": "GoogleCloudIntegrationsV2DuetBooleanParameterArray", +"properties": { +"booleanValues": { +"description": "Boolean array.", +"items": { +"type": "boolean" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetCloudSchedulerConfig": { +"description": "Cloud Scheduler Trigger configuration", +"id": "GoogleCloudIntegrationsV2DuetCloudSchedulerConfig", +"properties": { +"cronTab": { +"description": "Required. The cron tab of cloud scheduler trigger.", +"type": "string" +}, +"errorMessage": { +"description": "Optional. When the job was deleted from Pantheon UI, error_message will be populated when Get/List integrations", +"type": "string" +}, +"location": { +"description": "Required. The location where associated cloud scheduler job will be created", +"type": "string" +}, +"serviceAccountEmail": { +"description": "Required. Service account used by Cloud Scheduler to trigger the integration at scheduled time", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetDoubleParameterArray": { +"description": "This message only contains a field of double number array.", +"id": "GoogleCloudIntegrationsV2DuetDoubleParameterArray", +"properties": { +"doubleValues": { +"description": "Double number array.", +"items": { +"format": "double", +"type": "number" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetErrorCatcherConfig": { +"description": "Configuration detail of a error catch task", +"id": "GoogleCloudIntegrationsV2DuetErrorCatcherConfig", +"properties": { +"description": { +"description": "Optional. User-provided description intended to give more business context about the error catcher config.", +"type": "string" +}, +"errorCatcherId": { +"description": "Required. An error catcher id is string representation for the error catcher config. Within a workflow, error_catcher_id uniquely identifies an error catcher config among all error catcher configs for the workflow", +"type": "string" +}, +"errorCatcherNumber": { +"description": "Required. A number to uniquely identify each error catcher config within the workflow on UI.", +"type": "string" +}, +"label": { +"description": "Optional. The user created label for a particular error catcher. Optional.", +"type": "string" +}, +"startErrorTasks": { +"description": "Required. The set of start tasks that are to be executed for the error catch flow", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetNextTask" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetEventParameter": { +"description": "This message is used for processing and persisting (when applicable) key value pair parameters for each event in the event bus.", +"id": "GoogleCloudIntegrationsV2DuetEventParameter", +"properties": { +"key": { +"description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.", +"type": "string" +}, +"value": { +"$ref": "GoogleCloudIntegrationsV2DuetValueType", +"description": "Values for the defined keys. Each value can either be string, int, double or any proto message." +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetGenerateIntegrationBranchRequest": { +"description": "Request message for generating an integration branch containing tasks.", +"id": "GoogleCloudIntegrationsV2DuetGenerateIntegrationBranchRequest", +"properties": { +"integrationBranchRequest": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationBranchRequest", +"description": "Required. The integration branch request payload." +}, +"prompt": { +"description": "Required. User prompt.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetGenerateIntegrationBranchResponse": { +"description": "Response message containing the generated integration branch data.", +"id": "GoogleCloudIntegrationsV2DuetGenerateIntegrationBranchResponse", +"properties": { +"integrationBranch": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationBranch", +"description": "The integration branch returned by Duet" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetGenerateIntegrationDocumentRequest": { +"description": "Request message for generating documentation for an integration version.", +"id": "GoogleCloudIntegrationsV2DuetGenerateIntegrationDocumentRequest", +"properties": { +"integrationDocumentRequest": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationDocumentRequest", +"description": "Required. The integration document request payload." +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetGenerateIntegrationDocumentResponse": { +"description": "Response message containing generated integration documentation text.", +"id": "GoogleCloudIntegrationsV2DuetGenerateIntegrationDocumentResponse", +"properties": { +"document": { +"description": "The description of the integration returned by Duet AI.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetGenerateIntegrationRequest": { +"description": "Request for generating an integration.", +"id": "GoogleCloudIntegrationsV2DuetGenerateIntegrationRequest", +"properties": { +"copilotEnabled": { +"description": "Optional. Indicates if copilot is enabled. Copilot features may alter the generated integration structure.", +"type": "boolean" +}, +"prompt": { +"description": "Required. The natural language prompt based on which the integration will be generated.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetGenerateIntegrationResponse": { +"description": "Response for generating an integration.", +"id": "GoogleCloudIntegrationsV2DuetGenerateIntegrationResponse", +"properties": { +"skeletonIntegrations": { +"description": "The list of integration skeletons returned.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationSkeleton" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetGenerateJavascriptRequest": { +"description": "Request message for generating data mapping Javascript.", +"id": "GoogleCloudIntegrationsV2DuetGenerateJavascriptRequest", +"properties": { +"javascriptRequest": { +"$ref": "GoogleCloudIntegrationsV2DuetJavascriptRequest", +"description": "Required. The javascript request payload." +}, +"prompt": { +"description": "Optional. User prompt.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetGenerateJavascriptResponse": { +"description": "Response message containing generated Javascript code recommendations.", +"id": "GoogleCloudIntegrationsV2DuetGenerateJavascriptResponse", +"properties": { +"recommendations": { +"description": "List of the Javascript recommendations.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetJavascriptRecommendation" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetIntParameterArray": { +"description": "This message only contains a field of integer array.", +"id": "GoogleCloudIntegrationsV2DuetIntParameterArray", +"properties": { +"intValues": { +"description": "Integer array.", +"items": { +"format": "int64", +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetIntegrationBranch": { +"description": "An integration branch skeleton containing basic fields which can be used to create an integration branch on the UI.", +"id": "GoogleCloudIntegrationsV2DuetIntegrationBranch", +"properties": { +"branchCondition": { +"description": "The condition for the branch.", +"type": "string" +}, +"explanation": { +"description": "Explanation of why this integration branch was generated.", +"type": "string" +}, +"integrationParameters": { +"description": "The newly generated workflow parameters.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationParameter" +}, +"type": "array" +}, +"taskConfigs": { +"description": "The newly generated tasks which can be branched into the current integration.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetTaskConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetIntegrationBranchRequest": { +"description": "The request for generating an integration branch.", +"id": "GoogleCloudIntegrationsV2DuetIntegrationBranchRequest", +"properties": { +"branchCondition": { +"description": "Optional. The condition for the particular branch which the user selected.", +"type": "string" +}, +"integrationParameters": { +"description": "Optional. A list of all the workflow parameters of the current integration.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationParameter" +}, +"type": "array" +}, +"taskConfigs": { +"description": "Required. A list of all the tasks of the current integration.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetTaskConfig" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetIntegrationConfigParameter": { +"description": "Integration Config Parameter is defined in the integration config and are used to provide external configuration for integration. It provide information about data types of the expected parameters and provide any default values or value. They can also be used to add custom attributes.", +"id": "GoogleCloudIntegrationsV2DuetIntegrationConfigParameter", +"properties": { +"parameter": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationParameter", +"description": "Optional. Integration Parameter to provide the default value, data type and attributes required for the Integration config variables." +}, +"value": { +"$ref": "GoogleCloudIntegrationsV2DuetValueType", +"description": "Values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object." +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetIntegrationDocumentRequest": { +"description": "The request for generating description of an integration.", +"id": "GoogleCloudIntegrationsV2DuetIntegrationDocumentRequest", +"properties": { +"integrationVersion": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationVersion", +"description": "Required. The current integrtion on the canvas." +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetIntegrationParameter": { +"description": "Integration Parameter is defined in the integration config and are used to provide information about data types of the expected parameters and provide any default values if needed. They can also be used to add custom attributes. These are static in nature and should not be used for dynamic event definition.", +"id": "GoogleCloudIntegrationsV2DuetIntegrationParameter", +"properties": { +"dataType": { +"description": "Type of the parameter.", +"enum": [ +"INTEGRATION_PARAMETER_DATA_TYPE_UNSPECIFIED", +"STRING_VALUE", +"INT_VALUE", +"DOUBLE_VALUE", +"BOOLEAN_VALUE", +"STRING_ARRAY", +"INT_ARRAY", +"DOUBLE_ARRAY", +"BOOLEAN_ARRAY", +"JSON_VALUE", +"PROTO_VALUE", +"PROTO_ARRAY" +], +"enumDescriptions": [ +"Unspecified.", +"String.", +"Integer.", +"Double Number.", +"Boolean.", +"String Array.", +"Integer Array.", +"Double Number Array.", +"Boolean Array.", +"Json.", +"Proto Value (Internal use only).", +"Proto Array (Internal use only)." +], +"type": "string" +}, +"defaultValue": { +"$ref": "GoogleCloudIntegrationsV2DuetValueType", +"description": "Default values for the defined keys. Each value can either be string, int, double or any proto message or a serialized object." +}, +"description": { +"description": "Optional. Description of the parameter.", +"type": "string" +}, +"displayName": { +"description": "The name (without prefix) to be displayed in the UI for this parameter. E.g. if the key is \"foo.bar.myName\", then the name would be \"myName\".", +"type": "string" +}, +"inputOutputType": { +"description": "Specifies the input/output type for the parameter.", +"enum": [ +"IN_OUT_TYPE_UNSPECIFIED", +"IN", +"OUT", +"IN_OUT" +], +"enumDescriptions": [ +"Default.", +"Input parameters for the integration. EventBus validates that these parameters exist in the integrations before execution.", +"Output Parameters for the integration. EventBus will only return the integration parameters tagged with OUT in the response back.", +"Input and Output Parameters. These can be used as both input and output. EventBus will validate for the existence of these parameters before execution and will also return this parameter back in the response." +], +"type": "string" +}, +"isTransient": { +"description": "Whether this parameter is a transient parameter.", +"type": "boolean" +}, +"jsonSchema": { +"description": "This schema will be used to validate runtime JSON-typed values of this parameter.", +"type": "string" +}, +"key": { +"description": "Key is used to retrieve the corresponding parameter value. This should be unique for a given fired event. These parameters must be predefined in the integration definition.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetIntegrationSkeleton": { +"description": "An integration skeleton containing basic fields which can be used to create an integration on the UI.", +"id": "GoogleCloudIntegrationsV2DuetIntegrationSkeleton", +"properties": { +"explanation": { +"description": "Explanation of why this integration was generated.", +"type": "string" +}, +"integrationVersion": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationVersion", +"description": "The integration version containing basic triggers and tasks." +}, +"name": { +"description": "The name of the integration.", +"type": "string" +}, +"tag": { +"description": "Indicate the strategy/methodology used to generate the integration.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetIntegrationVersion": { +"description": "The integration version definition.", +"id": "GoogleCloudIntegrationsV2DuetIntegrationVersion", +"properties": { +"description": { +"description": "Optional. The integration description.", +"type": "string" +}, +"errorCatcherConfigs": { +"description": "Optional. Error Catch Task configuration for the integration. It's optional.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetErrorCatcherConfig" +}, +"type": "array" +}, +"integrationConfigParameters": { +"description": "Optional. Config Parameters that are expected to be passed to the integration when an integration is published. This consists of all the parameters that are expected to provide configuration in the integration execution. This gives the user the ability to provide default values, value, add information like connection url, project based configuration value and also provide data types of each parameter.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationConfigParameter" +}, +"type": "array" +}, +"integrationParameters": { +"description": "Optional. Parameters that are expected to be passed to the integration when an event is triggered. This consists of all the parameters that are expected in the integration execution. This gives the user the ability to provide default values, add information like PII and also provide data types of each parameter.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationParameter" +}, +"type": "array" +}, +"name": { +"description": "Optional. Auto-generated primary key.", +"type": "string" +}, +"snapshotNumber": { +"description": "Optional. An increasing sequence that is set when a new snapshot is created. The last created snapshot can be identified by [workflow_name, org_id latest(snapshot_number)]. However, last created snapshot need not be same as the HEAD. So users should always use \"HEAD\" tag to identify the head.", +"format": "int64", +"type": "string" +}, +"state": { +"description": "Output only. User should not set it as an input.", +"enum": [ +"INTEGRATION_STATE_UNSPECIFIED", +"DRAFT", +"ACTIVE", +"ARCHIVED", +"SNAPSHOT" +], +"enumDescriptions": [ +"Default.", +"Draft.", +"Active.", +"Archived.", +"Snapshot." +], +"readOnly": true, +"type": "string" +}, +"taskConfigs": { +"description": "Optional. Task configuration for the integration. It's optional, but the integration doesn't do anything without task_configs.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetTaskConfig" +}, +"type": "array" +}, +"triggerConfigs": { +"description": "Optional. Trigger configurations.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetTriggerConfig" +}, +"type": "array" +}, +"userLabel": { +"description": "Optional. A user-defined label that annotates an integration version. Typically, this is only set when the integration version is created.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetJavascriptRecommendation": { +"description": "Individual Javascript recommendation containing the task config with the new code, integration parameters and the explanation.", +"id": "GoogleCloudIntegrationsV2DuetJavascriptRecommendation", +"properties": { +"explanation": { +"description": "The explanation of the Javascript code.", +"type": "string" +}, +"integrationParameters": { +"description": "Optional. The list of the new integration parameters.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationParameter" +}, +"type": "array" +}, +"taskConfig": { +"$ref": "GoogleCloudIntegrationsV2DuetTaskConfig", +"description": "Optional. The task config of the Javascript task." +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetJavascriptRequest": { +"description": "Request message for Javascript Task using Gemini.", +"id": "GoogleCloudIntegrationsV2DuetJavascriptRequest", +"properties": { +"copilotEnabled": { +"description": "Optional. If this request is for copilot.", +"type": "boolean" +}, +"integrationVersion": { +"$ref": "GoogleCloudIntegrationsV2DuetIntegrationVersion", +"description": "Required. The integration version which contains all the integration parameters, all triggers and tasks including the Javascript task." +}, +"taskId": { +"description": "Required. The task id of the Javascript task.", +"type": "string" +}, +"useCurrentScript": { +"description": "Optional. Whether to use the current javascript task config (JS code) to generate the Javascript code.", +"type": "boolean" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetNextTask": { +"description": "The task that is next in line to be executed, if the condition specified evaluated to true.", +"id": "GoogleCloudIntegrationsV2DuetNextTask", +"properties": { +"condition": { +"description": "Standard filter expression for this task to become an eligible next task.", +"type": "string" +}, +"description": { +"description": "User-provided description intended to give additional business context about the task.", +"type": "string" +}, +"displayName": { +"description": "User-provided label that is attached to this edge in the UI.", +"type": "string" +}, +"taskConfigId": { +"description": "ID of the next task.", +"type": "string" +}, +"taskId": { +"description": "Task number of the next task.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetRecommendTasksRequest": { +"description": "Request message for recommending tasks to replace a selected task.", +"id": "GoogleCloudIntegrationsV2DuetRecommendTasksRequest", +"properties": { +"prompt": { +"description": "Optional. User prompt.", +"type": "string" +}, +"replaceTaskRequest": { +"$ref": "GoogleCloudIntegrationsV2DuetReplaceTaskRequest", +"description": "Required. The current task to replace and options." +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetRecommendTasksResponse": { +"description": "Response message containing recommended tasks for replacement.", +"id": "GoogleCloudIntegrationsV2DuetRecommendTasksResponse", +"properties": { +"taskConfigs": { +"description": "The list of recommended tasks.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetTaskConfig" +}, +"type": "array" +}, +"taskResponseStatuses": { +"description": "The list of task response status based on the task_types in the request.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetTaskResponseStatus" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetReplaceTaskRequest": { +"description": "Message for Replace Task Scenario.", +"id": "GoogleCloudIntegrationsV2DuetReplaceTaskRequest", +"properties": { +"copilotEnabled": { +"description": "Optional. If this request is for copilot.", +"type": "boolean" +}, +"taskConfig": { +"$ref": "GoogleCloudIntegrationsV2DuetTaskConfig", +"description": "Required. The current task selected on the UI." +}, +"taskTypes": { +"description": "The list of task types.", +"items": { +"enum": [ +"TASK_TYPE_UNSPECIFIED", +"CONNECTOR_TASK", +"REST_TASK" +], +"enumDescriptions": [ +"Unspecified.", +"Connector Task.", +"Rest task." +], +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetStringParameterArray": { +"description": "This message only contains a field of string array.", +"id": "GoogleCloudIntegrationsV2DuetStringParameterArray", +"properties": { +"stringValues": { +"description": "String array.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetTaskConfig": { +"description": "The task configuration details. This is not the implementation of Task. There might be multiple TaskConfigs for the same Task.", +"id": "GoogleCloudIntegrationsV2DuetTaskConfig", +"properties": { +"description": { +"description": "Optional. User-provided description intended to give additional business context about the task.", +"type": "string" +}, +"displayName": { +"description": "Optional. User-provided label that is attached to this TaskConfig in the UI.", +"type": "string" +}, +"errorCatcherId": { +"description": "Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task", +"type": "string" +}, +"externalTaskType": { +"description": "Optional. External task type of the task", +"enum": [ +"EXTERNAL_TASK_TYPE_UNSPECIFIED", +"NORMAL_TASK", +"ERROR_TASK" +], +"enumDescriptions": [ +"Default value. External task type is not specified", +"Tasks belongs to the normal task flows", +"Task belongs to the error catch task flows" +], +"type": "string" +}, +"nextTasks": { +"description": "Optional. The set of tasks that are next in line to be executed as per the execution graph defined for the parent event, specified by `event_config_id`. Each of these next tasks are executed only if the condition associated with them evaluates to true.", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetNextTask" +}, +"type": "array" +}, +"parameters": { +"additionalProperties": { +"$ref": "GoogleCloudIntegrationsV2DuetEventParameter" +}, +"description": "Optional. The customized parameters the user can pass to this task.", +"type": "object" +}, +"task": { +"description": "Optional. The name for the task.", +"type": "string" +}, +"taskId": { +"description": "Required. The identifier of this task within its parent event config, specified by the client. This should be unique among all the tasks belong to the same event config. We use this field as the identifier to find next tasks (via field `next_tasks.task_id`).", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetTaskResponseStatus": { +"description": "Message for task response status.", +"id": "GoogleCloudIntegrationsV2DuetTaskResponseStatus", +"properties": { +"errorMessage": { +"description": "The error message of the task response in case of failure.", +"type": "string" +}, +"httpCode": { +"description": "The http code of the task response.", +"format": "int32", +"type": "integer" +}, +"taskType": { +"description": "The task type.", +"enum": [ +"TASK_TYPE_UNSPECIFIED", +"CONNECTOR_TASK", +"REST_TASK" +], +"enumDescriptions": [ +"Unspecified.", +"Connector Task.", +"Rest task." +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetTriggerConfig": { +"description": "Configuration detail of a trigger.", +"id": "GoogleCloudIntegrationsV2DuetTriggerConfig", +"properties": { +"cloudSchedulerConfig": { +"$ref": "GoogleCloudIntegrationsV2DuetCloudSchedulerConfig", +"description": "Optional. Cloud Scheduler Trigger related metadata" +}, +"description": { +"description": "Optional. User-provided description intended to give additional business context about the task.", +"type": "string" +}, +"errorCatcherId": { +"description": "Optional. Optional Error catcher id of the error catch flow which will be executed when execution error happens in the task", +"type": "string" +}, +"inputVariables": { +"$ref": "GoogleCloudIntegrationsV2DuetTriggerConfigVariables", +"description": "Optional. List of input variables for the api trigger." +}, +"label": { +"description": "Optional. The user created label for a particular trigger.", +"type": "string" +}, +"outputVariables": { +"$ref": "GoogleCloudIntegrationsV2DuetTriggerConfigVariables", +"description": "Optional. List of output variables for the api trigger." +}, +"properties": { +"additionalProperties": { +"type": "string" +}, +"description": "Optional. Configurable properties of the trigger, not to be confused with integration parameters. E.g. \"name\" is a property for API triggers and \"subscription\" is a property for Pub/sub triggers.", +"type": "object" +}, +"startTasks": { +"description": "Optional. Set of tasks numbers from where the integration execution is started by this trigger. If this is empty, then integration is executed with default start tasks. In the list of start tasks, none of two tasks can have direct ancestor-descendant relationships (i.e. in a same integration execution graph).", +"items": { +"$ref": "GoogleCloudIntegrationsV2DuetNextTask" +}, +"type": "array" +}, +"trigger": { +"description": "Optional. Name of the trigger. Example: \"API Trigger\", \"Cloud Pub Sub Trigger\" When set will be sent out to monitoring dashabord for tracking purpose.", +"type": "string" +}, +"triggerId": { +"description": "Optional. The backend trigger ID.", +"type": "string" +}, +"triggerNumber": { +"description": "Required. A number to uniquely identify each trigger config within the integration on UI.", +"type": "string" +}, +"triggerType": { +"description": "Optional. Type of trigger", +"enum": [ +"TRIGGER_TYPE_UNSPECIFIED", +"CRON", +"API", +"SFDC_CHANNEL", +"CLOUD_PUBSUB_EXTERNAL", +"SFDC_CDC_CHANNEL", +"CLOUD_SCHEDULER", +"INTEGRATION_CONNECTOR_TRIGGER", +"PRIVATE_TRIGGER" +], +"enumDescriptions": [ +"Unknown.", +"Trigger by scheduled time.", +"Trigger by API call.", +"Trigger by Salesforce Channel.", +"Trigger by Pub/Sub external.", +"SFDC Channel Trigger for CDC.", +"Trigger by Cloud Scheduler job.", +"Trigger by Connector Event", +"Trigger for private workflow" +], +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetTriggerConfigVariables": { +"description": "Variables names mapped to api trigger.", +"id": "GoogleCloudIntegrationsV2DuetTriggerConfigVariables", +"properties": { +"names": { +"description": "Optional. List of variable names.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetTroubleshootExecutionResponse": { +"description": "Response for troubleshooting an integration execution.", +"id": "GoogleCloudIntegrationsV2DuetTroubleshootExecutionResponse", +"properties": { +"detailedExplanation": { +"description": "Detailed explanation of the root cause of the integration execution failure.", +"type": "string" +}, +"displayMessage": { +"description": "Display message to be shown to the user. Example - If integration execution succeeded, this field value can be \"Integration execution succeeded. No troubleshooting needed.\".", +"type": "string" +}, +"errorMessage": { +"description": "Error message of the integration execution, if the execution failed.", +"type": "string" +}, +"executionId": { +"description": "The execution id of the integration execution to be troubleshooted.", +"type": "string" +}, +"rootCause": { +"description": "Root cause of the integration execution failure.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2DuetValueType": { +"description": "The type of the parameter.", +"id": "GoogleCloudIntegrationsV2DuetValueType", +"properties": { +"booleanArray": { +"$ref": "GoogleCloudIntegrationsV2DuetBooleanParameterArray", +"description": "Boolean Array." +}, +"booleanValue": { +"description": "Boolean.", +"type": "boolean" +}, +"doubleArray": { +"$ref": "GoogleCloudIntegrationsV2DuetDoubleParameterArray", +"description": "Double Number Array." +}, +"doubleValue": { +"description": "Double Number.", +"format": "double", +"type": "number" +}, +"intArray": { +"$ref": "GoogleCloudIntegrationsV2DuetIntParameterArray", +"description": "Integer Array." +}, +"intValue": { +"description": "Integer.", +"format": "int64", +"type": "string" +}, +"jsonValue": { +"description": "Json.", +"type": "string" +}, +"stringArray": { +"$ref": "GoogleCloudIntegrationsV2DuetStringParameterArray", +"description": "String Array." +}, +"stringValue": { +"description": "String.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2Execution": { +"description": "The Execution contains detailed information of an individual integration execution.", +"id": "GoogleCloudIntegrationsV2Execution", +"properties": { +"cloudLoggingDetails": { +"$ref": "GoogleCloudIntegrationsV2CloudLoggingDetails", +"description": "Cloud Logging details for the integration version" +}, +"containTaskVariables": { +"description": "Indicates if the task execution contains variables.", +"type": "boolean" +}, +"createTime": { +"description": "Output only. Time the execution is created.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +}, +"executionAttemptStats": { +"description": "Start and end time of each execution attempt.", +"items": { +"$ref": "GoogleCloudIntegrationsV2AttemptStats" +}, +"type": "array" +}, +"integrationVersionNumber": { +"description": "Indicates which snapshot of integration is used for this execution.", +"format": "int64", +"type": "string" +}, +"integrationVersionUserLabel": { +"description": "Optional. User-defined label that annotates the executed integration version.", +"type": "string" +}, +"name": { +"description": "Identifier. Execution resource name.", +"type": "string" +}, +"replayInfo": { +"$ref": "GoogleCloudIntegrationsV2ExecutionReplayInfo", +"description": "Output only. Replay info for the execution", +"readOnly": true +}, +"requestVariables": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Variables provided in the request.", +"type": "object" +}, +"responseVariables": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Variables returned as part of the response.", +"type": "object" +}, +"state": { +"description": "Output only. Status of the execution.", +"enum": [ +"STATE_UNSPECIFIED", +"ON_HOLD", +"IN_PROCESS", +"SUCCEEDED", +"FAILED", +"CANCELLED", +"RETRY_ON_HOLD", +"SUSPENDED" +], +"enumDescriptions": [ +"Default.", +"Execution is scheduled and awaiting to be triggered.", +"Execution is processing.", +"Execution successfully finished. There are no more changes after this state.", +"Execution failed. There's no more change after this state.", +"Execution is cancelled. There's no more change after this state.", +"Execution failed and is waiting for retry.", +"Execution suspended and waiting for manual intervention." +], +"readOnly": true, +"type": "string" +}, +"taskExecutions": { +"description": "Optional. List of task executions.", +"items": { +"$ref": "GoogleCloudIntegrationsV2TaskExecution" +}, +"type": "array" +}, +"triggerId": { +"description": "The ID of the trigger invoked at the start of the execution.", +"type": "string" +}, +"updateTime": { +"description": "Output only. Time the execution is recently updated.", +"format": "google-datetime", +"readOnly": true, +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2ExecutionReplayInfo": { +"description": "Contains the details of the execution info: this includes the replay reason and replay tree connecting executions in a parent-child relationship", +"id": "GoogleCloudIntegrationsV2ExecutionReplayInfo", +"properties": { +"originalExecutionId": { +"description": "If this execution is a replay of another execution, then this field contains the original execution id.", +"type": "string" +}, +"replayMode": { +"description": "Replay mode for the execution", +"enum": [ +"REPLAY_MODE_UNSPECIFIED", +"REPLAY_MODE_FROM_BEGINNING", +"REPLAY_MODE_POINT_OF_FAILURE" +], +"enumDescriptions": [ +"Default value.", +"Replay the original execution from the beginning.", +"Replay the execution from the first failed task." +], +"type": "string" +}, +"replayReason": { +"description": "reason for replay", +"type": "string" +}, +"replayedExecutionIds": { +"description": "If this execution has been replayed, then this field contains the execution ids of the replayed executions.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2ListExecutionsResponse": { +"description": "Response for listing the Integration executions.", +"id": "GoogleCloudIntegrationsV2ListExecutionsResponse", +"properties": { +"executions": { +"description": "Required. The list of executions.", +"items": { +"$ref": "GoogleCloudIntegrationsV2Execution" +}, +"type": "array" +}, +"nextPageToken": { +"description": "The token for retrieving the next page of results.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2TaskExecution": { +"description": "Execution of a single task within an integration", +"id": "GoogleCloudIntegrationsV2TaskExecution", +"properties": { +"name": { +"description": "Identifier. Task execution resource name.", +"type": "string" +}, +"taskExecutionDetails": { +"description": "Details of the task execution.", +"items": { +"$ref": "GoogleCloudIntegrationsV2TaskExecutionDetails" +}, +"type": "array" +}, +"taskExecutionMetadata": { +"$ref": "GoogleCloudIntegrationsV2TaskExecutionTaskExecutionMetadata", +"description": "Optional. Metadata of the task execution." +}, +"variables": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Optional. Variables used during the execution.", +"type": "object" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2TaskExecutionDetails": { +"description": "Details of the task execution.", +"id": "GoogleCloudIntegrationsV2TaskExecutionDetails", +"properties": { +"taskAttemptStats": { +"description": "List for the current task execution attempts.", +"items": { +"$ref": "GoogleCloudIntegrationsV2AttemptStats" +}, +"type": "array" +}, +"taskExecutionState": { +"description": "Output only. The execution state of this task.", +"enum": [ +"STATE_UNSPECIFIED", +"IN_PROCESS", +"SUCCEED", +"FAILED", +"FATAL", +"RETRY_ON_HOLD", +"CANCELLED", +"SUSPENDED" +], +"enumDescriptions": [ +"Default value.", +"Task is under processing.", +"Task execution successfully finished. There are no more changes after this state.", +"Task execution failed. There's no more change after this state.", +"Task execution failed and cause the whole integration execution to fail immediately. There's no more change after this state.", +"Task execution failed and is waiting for retry.", +"Task execution cancelled when in progress. This happens when integration execution was cancelled or any other task fell into a fatal state.", +"Task is a SuspensionTask which has executed once, creating a pending suspension." +], +"readOnly": true, +"type": "string" +}, +"taskNumber": { +"description": "Pointer to the task config it used for execution.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleCloudIntegrationsV2TaskExecutionTaskExecutionMetadata": { +"description": "Metadata of the task execution.", +"id": "GoogleCloudIntegrationsV2TaskExecutionTaskExecutionMetadata", +"properties": { +"ancestorIterationNumbers": { +"description": "Optional. Ancestor iteration number for the task (it will only be non-empty if the task is under 'private integration').", +"items": { +"type": "string" +}, +"type": "array" +}, +"ancestorTaskNumbers": { +"description": "Optional. Ancestor task number for the task (it will only be non-empty if the task is under 'private integration').", +"items": { +"type": "string" +}, +"type": "array" +}, +"executionAttempt": { +"description": "The execution attempt number this execution belongs to.", +"format": "int32", +"type": "integer" +}, +"privateIntegrationName": { +"description": "Optional. The direct integration which the execution belongs to.", +"type": "string" +}, +"task": { +"description": "The task name associated with this execution.", +"type": "string" +}, +"taskAttempt": { +"description": "The task attempt number this execution belongs to.", +"format": "int32", +"type": "integer" +}, +"taskLabel": { +"description": "The task label associated with this execution.", +"type": "string" +}, +"taskNumber": { +"description": "The task number associated with this execution.", +"type": "string" +} +}, +"type": "object" +}, +"GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest": { +"description": "LINT.IfChange Use this request to post all workflows associated with a given trigger id. Next available id: 13", +"id": "GoogleInternalCloudCrmEventbusV3PostToQueueWithTriggerIdRequest", +"properties": { +"clientId": { +"description": "Optional. If the client id is provided, then the combination of trigger id and client id is matched across all the workflows. If the client id is not provided, then workflows with matching trigger id are executed for each client id in the {@link TriggerConfig}. For Api Trigger, the client id is required and will be validated against the allowed clients.", +"type": "string" +}, +"ignoreErrorIfNoActiveWorkflow": { +"description": "Optional. Flag to determine whether clients would suppress a warning when no ACTIVE workflows are not found. If this flag is set to be true, an error will not be thrown if the requested trigger_id or client_id is not found in any ACTIVE workflow. Otherwise, the error is always thrown. The flag is set to be false by default.", +"type": "boolean" +}, +"parameters": { +"$ref": "EnterpriseCrmEventbusProtoEventParameters", +"description": "Passed in as parameters to each workflow execution. Optional." +}, +"priority": { +"description": "The request priority this request should be processed at. For internal users:", +"enum": [ +"UNSPCIFIED", +"SHEDDABLE", +"SHEDDABLE_PLUS", +"CRITICAL", +"CRITICAL_PLUS" +], +"enumDescriptions": [ +"Unspecified", +"Frequent partial and occasional full unavailability is expected and not pageable. * Requests to this band will be shed before all other requests. * This is the default for async calls sent from batch jobs.", +"Partial unavailability is expected and is not necessarily pageable. * Requests to this band will be shed before any critical traffic. * This is the default for async calls sent from production jobs.", +"Any outage is a pageable event. * During a production outage requests in this band will only be shed before CRITICAL_PLUS. * This is the default for sync calls sent from production jobs.", +"Any outage is a pageable event. * The guideline is for < 10% of requests to a service to be in this band. * During a production outage requests in this band will be prioritized above all others. * Opt-in to CRITICAL_PLUS when your workflow triggers by human." +], +"type": "string" +}, +"quotaRetryCount": { +"description": "Optional. This is a field to see the quota retry count for integration execution", +"format": "int32", +"type": "integer" +}, +"requestId": { +"description": "Optional. This is used to de-dup incoming request: if the duplicate request was detected, the response from the previous execution is returned. Must have no more than 36 characters and contain only alphanumeric characters and hyphens.", +"type": "string" +}, +"resourceName": { +"description": "This field is only required when using Admin Access. The resource name of target, or the parent resource name. For example: \"projects/*/locations/*/integrations/*\"", +"type": "string" +}, +"scheduledTime": { +"description": "Optional. Time in milliseconds since epoch when the given event would be scheduled.", +"format": "int64", +"type": "string" +}, +"testMode": { +"description": "Optional. Sets test mode in {@link enterprise/crm/eventbus/event_message.proto}.", +"type": "boolean" +}, +"triggerId": { +"description": "Matched against all {@link TriggerConfig}s across all workflows. i.e. TriggerConfig.trigger_id.equals(trigger_id) Required.", +"type": "string" +}, +"userGeneratedExecutionId": { +"description": "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.", +"type": "string" +}, +"workflowName": { +"description": "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.", +"type": "string" +} +}, +"type": "object" +} +}, +"servicePath": "", +"title": "Application Integration API", +"version": "v2", +"version_module": true +} \ No newline at end of file From 76afe32ebf797228fd832d5714f079fb58feb28b Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:38 +0000 Subject: [PATCH 28/41] feat(networkconnectivity): update the api #### networkconnectivity:v1 The following keys were added: - schemas.InternalRange.properties.purpose.type (Total Keys: 1) - schemas.InternalRange.properties.rangeStatus (Total Keys: 2) - schemas.Spoke.properties.fieldPathsPendingUpdate.readOnly (Total Keys: 1) #### networkconnectivity:v1alpha1 The following keys were added: - schemas.InternalRange.properties.purpose.type (Total Keys: 1) --- ...ty_v1.projects.locations.global_.hubs.html | 2 +- ..._v1.projects.locations.internalRanges.html | 8 ++++ ...ectivity_v1.projects.locations.spokes.html | 8 ++-- ...ha1.projects.locations.internalRanges.html | 4 ++ .../documents/networkconnectivity.v1.json | 38 ++++++++++++++++++- .../networkconnectivity.v1alpha1.json | 16 +++++++- 6 files changed, 68 insertions(+), 8 deletions(-) diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html index ff359101c7..8218ef54b8 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.global_.hubs.html @@ -560,7 +560,7 @@

Method Details

"createTime": "A String", # Output only. The time the spoke was created. "description": "A String", # Optional. An optional description of the spoke. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "fieldPathsPendingUpdate": [ # Optional. The list of fields waiting for hub administrator's approval. + "fieldPathsPendingUpdate": [ # Output only. The list of fields waiting for hub administrator's approval. "A String", ], "gateway": { # A gateway that can apply specialized traffic processing. # Optional. This is a gateway that can apply specialized processing to traffic going through it. diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.internalRanges.html b/docs/dyn/networkconnectivity_v1.projects.locations.internalRanges.html index 5c92ede610..b311c9bfa7 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.internalRanges.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.internalRanges.html @@ -145,6 +145,8 @@

Method Details

], "peering": "A String", # Optional. The type of peering set for this internal range. "prefixLength": 42, # Optional. An alternate to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter. + "purpose": "A String", # Optional. The purpose of this internal range. Defines the intended use of the range and any restrictions associated with it. If not specified, it defaults to VPC_SUBNET. + "rangeStatus": "A String", # Output only. Status of the Internal Range. "targetCidrRange": [ # Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"] address space (for auto-mode networks, the "10.0.0.0/9" range is used instead of "10.0.0.0/8"). This can be used to target the search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC. "A String", ], @@ -262,6 +264,8 @@

Method Details

], "peering": "A String", # Optional. The type of peering set for this internal range. "prefixLength": 42, # Optional. An alternate to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter. + "purpose": "A String", # Optional. The purpose of this internal range. Defines the intended use of the range and any restrictions associated with it. If not specified, it defaults to VPC_SUBNET. + "rangeStatus": "A String", # Output only. Status of the Internal Range. "targetCidrRange": [ # Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"] address space (for auto-mode networks, the "10.0.0.0/9" range is used instead of "10.0.0.0/8"). This can be used to target the search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC. "A String", ], @@ -367,6 +371,8 @@

Method Details

], "peering": "A String", # Optional. The type of peering set for this internal range. "prefixLength": 42, # Optional. An alternate to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter. + "purpose": "A String", # Optional. The purpose of this internal range. Defines the intended use of the range and any restrictions associated with it. If not specified, it defaults to VPC_SUBNET. + "rangeStatus": "A String", # Output only. Status of the Internal Range. "targetCidrRange": [ # Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"] address space (for auto-mode networks, the "10.0.0.0/9" range is used instead of "10.0.0.0/8"). This can be used to target the search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC. "A String", ], @@ -433,6 +439,8 @@

Method Details

], "peering": "A String", # Optional. The type of peering set for this internal range. "prefixLength": 42, # Optional. An alternate to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter. + "purpose": "A String", # Optional. The purpose of this internal range. Defines the intended use of the range and any restrictions associated with it. If not specified, it defaults to VPC_SUBNET. + "rangeStatus": "A String", # Output only. Status of the Internal Range. "targetCidrRange": [ # Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"] address space (for auto-mode networks, the "10.0.0.0/9" range is used instead of "10.0.0.0/8"). This can be used to target the search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC. "A String", ], diff --git a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html index 7a8dc587e4..ee39793884 100644 --- a/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html +++ b/docs/dyn/networkconnectivity_v1.projects.locations.spokes.html @@ -128,7 +128,7 @@

Method Details

"createTime": "A String", # Output only. The time the spoke was created. "description": "A String", # Optional. An optional description of the spoke. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "fieldPathsPendingUpdate": [ # Optional. The list of fields waiting for hub administrator's approval. + "fieldPathsPendingUpdate": [ # Output only. The list of fields waiting for hub administrator's approval. "A String", ], "gateway": { # A gateway that can apply specialized traffic processing. # Optional. This is a gateway that can apply specialized processing to traffic going through it. @@ -343,7 +343,7 @@

Method Details

"createTime": "A String", # Output only. The time the spoke was created. "description": "A String", # Optional. An optional description of the spoke. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "fieldPathsPendingUpdate": [ # Optional. The list of fields waiting for hub administrator's approval. + "fieldPathsPendingUpdate": [ # Output only. The list of fields waiting for hub administrator's approval. "A String", ], "gateway": { # A gateway that can apply specialized traffic processing. # Optional. This is a gateway that can apply specialized processing to traffic going through it. @@ -547,7 +547,7 @@

Method Details

"createTime": "A String", # Output only. The time the spoke was created. "description": "A String", # Optional. An optional description of the spoke. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "fieldPathsPendingUpdate": [ # Optional. The list of fields waiting for hub administrator's approval. + "fieldPathsPendingUpdate": [ # Output only. The list of fields waiting for hub administrator's approval. "A String", ], "gateway": { # A gateway that can apply specialized traffic processing. # Optional. This is a gateway that can apply specialized processing to traffic going through it. @@ -710,7 +710,7 @@

Method Details

"createTime": "A String", # Output only. The time the spoke was created. "description": "A String", # Optional. An optional description of the spoke. "etag": "A String", # Optional. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. - "fieldPathsPendingUpdate": [ # Optional. The list of fields waiting for hub administrator's approval. + "fieldPathsPendingUpdate": [ # Output only. The list of fields waiting for hub administrator's approval. "A String", ], "gateway": { # A gateway that can apply specialized traffic processing. # Optional. This is a gateway that can apply specialized processing to traffic going through it. diff --git a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html index 128fc069ac..3c2dac78c0 100644 --- a/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html +++ b/docs/dyn/networkconnectivity_v1alpha1.projects.locations.internalRanges.html @@ -145,6 +145,7 @@

Method Details

], "peering": "A String", # Optional. The type of peering set for this internal range. "prefixLength": 42, # Optional. An alternative to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter. + "purpose": "A String", # Optional. The purpose of this internal range. Defines the intended use of the range and any restrictions associated with it. If not specified, it defaults to VPC_SUBNET. "rangeStatus": "A String", # Output only. Status of the Internal Range. "targetCidrRange": [ # Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"] address space (for auto-mode networks, the "10.0.0.0/9" range is used instead of "10.0.0.0/8"). This can be used to target the search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC. "A String", @@ -263,6 +264,7 @@

Method Details

], "peering": "A String", # Optional. The type of peering set for this internal range. "prefixLength": 42, # Optional. An alternative to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter. + "purpose": "A String", # Optional. The purpose of this internal range. Defines the intended use of the range and any restrictions associated with it. If not specified, it defaults to VPC_SUBNET. "rangeStatus": "A String", # Output only. Status of the Internal Range. "targetCidrRange": [ # Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"] address space (for auto-mode networks, the "10.0.0.0/9" range is used instead of "10.0.0.0/8"). This can be used to target the search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC. "A String", @@ -369,6 +371,7 @@

Method Details

], "peering": "A String", # Optional. The type of peering set for this internal range. "prefixLength": 42, # Optional. An alternative to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter. + "purpose": "A String", # Optional. The purpose of this internal range. Defines the intended use of the range and any restrictions associated with it. If not specified, it defaults to VPC_SUBNET. "rangeStatus": "A String", # Output only. Status of the Internal Range. "targetCidrRange": [ # Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"] address space (for auto-mode networks, the "10.0.0.0/9" range is used instead of "10.0.0.0/8"). This can be used to target the search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC. "A String", @@ -436,6 +439,7 @@

Method Details

], "peering": "A String", # Optional. The type of peering set for this internal range. "prefixLength": 42, # Optional. An alternative to ip_cidr_range. Can be set when trying to create an IPv4 reservation that automatically finds a free range of the given size. If both ip_cidr_range and prefix_length are set, there is an error if the range sizes do not match. Can also be used during updates to change the range size. NOTE: For IPv6 this field only works if ip_cidr_range is set as well, and both fields must match. In other words, with IPv6 this field only works as a redundant parameter. + "purpose": "A String", # Optional. The purpose of this internal range. Defines the intended use of the range and any restrictions associated with it. If not specified, it defaults to VPC_SUBNET. "rangeStatus": "A String", # Output only. Status of the Internal Range. "targetCidrRange": [ # Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"] address space (for auto-mode networks, the "10.0.0.0/9" range is used instead of "10.0.0.0/8"). This can be used to target the search in other rfc-1918 address spaces like "172.16.0.0/12" and "192.168.0.0/16" or non-rfc-1918 address spaces used in the VPC. "A String", diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json index 46604be68f..ebccce968b 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1.json @@ -4046,7 +4046,7 @@ } } }, -"revision": "20260908", +"revision": "20260929", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AcceptHubSpokeRequest": { @@ -5434,6 +5434,39 @@ "format": "int32", "type": "integer" }, +"purpose": { +"description": "Optional. The purpose of this internal range. Defines the intended use of the range and any restrictions associated with it. If not specified, it defaults to VPC_SUBNET.", +"enum": [ +"PURPOSE_UNSPECIFIED", +"VPC_SUBNET", +"INTERNAL_ADDRESS" +], +"enumDescriptions": [ +"If purpose is left unspecified in CreateInternalRange or UpdateInternalRange, it will be defaulted to VPC_SUBNET.", +"The internal range is used for VPC subnetworks.", +"The internal range is used exclusively for allocating individual IP addresses (e.g., for global PSC endpoints). Child ranges or subnetworks cannot be created from a range with this purpose." +], +"type": "string" +}, +"rangeStatus": { +"description": "Output only. Status of the Internal Range.", +"enum": [ +"RANGE_STATUS_UNSPECIFIED", +"ACTIVE", +"OBSOLETE", +"CREATING", +"DELETING" +], +"enumDescriptions": [ +"Unspecified status is the default value for an Internal Range.", +"Ranges with ACTIVE status will reserve the CIDR block from the given VPC.", +"A range becomes OBSOLETE if its VPC network is deleted. An OBSOLETE range is inactive, doesn't reserve any CIDR blocks, and can only be deleted or have its labels and description updated.", +"The resource is being created.", +"The resource is being deleted." +], +"readOnly": true, +"type": "string" +}, "targetCidrRange": { "description": "Optional. Can be set to narrow down or pick a different address space while searching for a free range. If not set, defaults to the [\"10.0.0.0/8\", \"172.16.0.0/12\", \"192.168.0.0/16\"] address space (for auto-mode networks, the \"10.0.0.0/9\" range is used instead of \"10.0.0.0/8\"). This can be used to target the search in other rfc-1918 address spaces like \"172.16.0.0/12\" and \"192.168.0.0/16\" or non-rfc-1918 address spaces used in the VPC.", "items": { @@ -7783,10 +7816,11 @@ "type": "string" }, "fieldPathsPendingUpdate": { -"description": "Optional. The list of fields waiting for hub administrator's approval.", +"description": "Output only. The list of fields waiting for hub administrator's approval.", "items": { "type": "string" }, +"readOnly": true, "type": "array" }, "gateway": { diff --git a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json index 12161dec12..26327b86c4 100644 --- a/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json +++ b/googleapiclient/discovery_cache/documents/networkconnectivity.v1alpha1.json @@ -1127,7 +1127,7 @@ } } }, -"revision": "20260701", +"revision": "20260929", "rootUrl": "https://networkconnectivity.googleapis.com/", "schemas": { "AllocationOptions": { @@ -1509,6 +1509,20 @@ "format": "int32", "type": "integer" }, +"purpose": { +"description": "Optional. The purpose of this internal range. Defines the intended use of the range and any restrictions associated with it. If not specified, it defaults to VPC_SUBNET.", +"enum": [ +"PURPOSE_UNSPECIFIED", +"VPC_SUBNET", +"INTERNAL_ADDRESS" +], +"enumDescriptions": [ +"If purpose is left unspecified in CreateInternalRange or UpdateInternalRange, it will be defaulted to VPC_SUBNET.", +"The internal range is used for VPC subnetworks.", +"The internal range is used exclusively for allocating individual IP addresses (e.g., for global PSC endpoints). Child ranges or subnetworks cannot be created from a range with this purpose." +], +"type": "string" +}, "rangeStatus": { "description": "Output only. Status of the Internal Range.", "enum": [ From c7690bff598b97bd6087e0b89c1df5f9fd53fb62 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:38 +0000 Subject: [PATCH 29/41] feat(networkmanagement): update the api #### networkmanagement:v1 The following keys were deleted: - schemas.DirectVpcIngressConnectionInfo (Total Keys: 7) - schemas.Step.properties.directVpcIngressConnection.$ref (Total Keys: 1) #### networkmanagement:v1beta1 The following keys were deleted: - schemas.DirectVpcIngressConnectionInfo (Total Keys: 7) - schemas.Step.properties.directVpcIngressConnection.$ref (Total Keys: 1) --- ...s.locations.global_.connectivityTests.html | 80 ++++--------------- ...s.locations.global_.connectivityTests.html | 80 ++++--------------- .../documents/networkmanagement.v1.json | 42 ++-------- .../documents/networkmanagement.v1beta1.json | 42 ++-------- 4 files changed, 44 insertions(+), 200 deletions(-) diff --git a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html index 2d5348ef2a..4781a12253 100644 --- a/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1.projects.locations.global_.connectivityTests.html @@ -274,10 +274,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -306,13 +307,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection for Cloud Run. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -655,10 +649,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -687,13 +682,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection for Cloud Run. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -1245,10 +1233,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -1277,13 +1266,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection for Cloud Run. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -1626,10 +1608,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -1658,13 +1641,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection for Cloud Run. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -2207,10 +2183,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -2239,13 +2216,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection for Cloud Run. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -2588,10 +2558,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -2620,13 +2591,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection for Cloud Run. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -3128,10 +3092,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -3160,13 +3125,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection for Cloud Run. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -3509,10 +3467,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -3541,13 +3500,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection for Cloud Run. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, diff --git a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html index 68327dacea..8b97ee2687 100644 --- a/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html +++ b/docs/dyn/networkmanagement_v1beta1.projects.locations.global_.connectivityTests.html @@ -275,10 +275,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -307,13 +308,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -656,10 +650,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -688,13 +683,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -1248,10 +1236,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -1280,13 +1269,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -1629,10 +1611,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -1661,13 +1644,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -2212,10 +2188,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -2244,13 +2221,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -2593,10 +2563,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -2625,13 +2596,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -3135,10 +3099,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -3167,13 +3132,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, @@ -3516,10 +3474,11 @@

Method Details

}, "cloudRunRevision": { # For display only. Metadata associated with a Cloud Run revision. # Display information of a Cloud Run revision. "displayName": "A String", # Name of a Cloud Run revision. + "ipAddress": "A String", # IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps. "location": "A String", # Location in which this revision is deployed. "serviceUri": "A String", # URI of Cloud Run service this revision belongs to. Format: `projects/{project_id}/locations/{location}/services/{service_id}` Mutually exclusive with `worker_pool_uri`. "uri": "A String", # URI of the Cloud Run revision. Format: `projects/{project_id}/locations/{location}/revisions/{revision_id}` - "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`. + "workerPoolUri": "A String", # URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`. }, "cloudSqlInstance": { # For display only. Metadata associated with a Cloud SQL instance. # Display information of a Cloud SQL instance. "displayName": "A String", # Name of a Cloud SQL instance. @@ -3548,13 +3507,6 @@

Method Details

"selectedIpRange": "A String", # Selected IP range. "subnetworkUri": "A String", # URI of the subnetwork for direct egress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` }, - "directVpcIngressConnection": { # For display only. Metadata associated with a serverless direct VPC ingress connection. # Display information of a serverless direct VPC ingress connection. - "networkUri": "A String", # URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}` - "region": "A String", # Region in which the Direct VPC ingress is deployed. - "selectedIpAddress": "A String", # Selected destination IP address, from the selected IP range. - "selectedIpRange": "A String", # Selected IP range. - "subnetworkUri": "A String", # URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}` - }, "dmsPrivateConnection": { # For display only. Metadata associated with a Private Connection. # Display information of a DMS Private Connection. "uri": "A String", # URI of the Private Connection in format "projects/{project_id}/locations/{location}/privateConnections/{private_connection_id}" }, diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json index 91e869b73a..d7a9b663f2 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1.json @@ -1797,7 +1797,7 @@ } } }, -"revision": "20260909", +"revision": "20260923", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -2169,6 +2169,10 @@ false "description": "Name of a Cloud Run revision.", "type": "string" }, +"ipAddress": { +"description": "IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps.", +"type": "string" +}, "location": { "description": "Location in which this revision is deployed.", "type": "string" @@ -2182,7 +2186,7 @@ false "type": "string" }, "workerPoolUri": { -"description": "URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`.", +"description": "URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`.", "type": "string" } }, @@ -2422,33 +2426,6 @@ false }, "type": "object" }, -"DirectVpcIngressConnectionInfo": { -"description": "For display only. Metadata associated with a serverless direct VPC ingress connection.", -"id": "DirectVpcIngressConnectionInfo", -"properties": { -"networkUri": { -"description": "URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}`", -"type": "string" -}, -"region": { -"description": "Region in which the Direct VPC ingress is deployed.", -"type": "string" -}, -"selectedIpAddress": { -"description": "Selected destination IP address, from the selected IP range.", -"type": "string" -}, -"selectedIpRange": { -"description": "Selected IP range.", -"type": "string" -}, -"subnetworkUri": { -"description": "URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`", -"type": "string" -} -}, -"type": "object" -}, "DropInfo": { "description": "Details of the final state \"drop\" and associated resource.", "id": "DropInfo", @@ -5440,10 +5417,6 @@ false "$ref": "DirectVpcEgressConnectionInfo", "description": "Display information of a serverless direct VPC egress connection." }, -"directVpcIngressConnection": { -"$ref": "DirectVpcIngressConnectionInfo", -"description": "Display information of a serverless direct VPC ingress connection for Cloud Run." -}, "dmsPrivateConnection": { "$ref": "PrivateConnectionInfo", "description": "Display information of a DMS Private Connection." @@ -5591,7 +5564,6 @@ false "ARRIVE_AT_VPC_CONNECTOR", "ARRIVE_AT_GKE_POD", "DIRECT_VPC_EGRESS_CONNECTION", -"ARRIVE_AT_DIRECT_VPC_INGRESS_CONNECTION", "SERVERLESS_EXTERNAL_CONNECTION", "NGFW_PACKET_INSPECTION", "NAT", @@ -5656,7 +5628,6 @@ false, false, false, false, -false, false ], "enumDescriptions": [ @@ -5695,7 +5666,6 @@ false "Forwarding state: arriving at a VPC connector.", "Forwarding state: arriving at a GKE Pod.", "Forwarding state: for packets originating from a serverless endpoint forwarded through Direct VPC egress.", -"Forwarding state: arriving at a direct VPC ingress connection.", "Forwarding state: for packets originating from a serverless endpoint forwarded through public (external) connectivity.", "Forwarding state: Layer 7 packet inspection by the firewall endpoint based on the configured security profile group.", "Transition state: packet header translated. The `nat` field is populated with the translation information.", diff --git a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json index ea8ff40fdf..e79f33c548 100644 --- a/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/networkmanagement.v1beta1.json @@ -1237,7 +1237,7 @@ } } }, -"revision": "20260909", +"revision": "20260923", "rootUrl": "https://networkmanagement.googleapis.com/", "schemas": { "AbortInfo": { @@ -1609,6 +1609,10 @@ false "description": "Name of a Cloud Run revision.", "type": "string" }, +"ipAddress": { +"description": "IP address of a Cloud Run revision. If the Cloud Run revision is in dual-stack subnetwork, this is the IP address relevant to the trace. Populated for `ARRIVE_AT_CLOUD_RUN_REVISION` steps.", +"type": "string" +}, "location": { "description": "Location in which this revision is deployed.", "type": "string" @@ -1622,7 +1626,7 @@ false "type": "string" }, "workerPoolUri": { -"description": "URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}`. Mutually exclusive with `service_uri`.", +"description": "URI of Cloud Run worker pool this revision belongs to. Format: `projects/{project_id}/locations/{location}/workerPools/{worker_pool_id}` Mutually exclusive with `service_uri`.", "type": "string" } }, @@ -1862,33 +1866,6 @@ false }, "type": "object" }, -"DirectVpcIngressConnectionInfo": { -"description": "For display only. Metadata associated with a serverless direct VPC ingress connection.", -"id": "DirectVpcIngressConnectionInfo", -"properties": { -"networkUri": { -"description": "URI of the VPC network for direct ingress. Format: `projects/{project_id}/global/networks/{network_id}`", -"type": "string" -}, -"region": { -"description": "Region in which the Direct VPC ingress is deployed.", -"type": "string" -}, -"selectedIpAddress": { -"description": "Selected destination IP address, from the selected IP range.", -"type": "string" -}, -"selectedIpRange": { -"description": "Selected IP range.", -"type": "string" -}, -"subnetworkUri": { -"description": "URI of the subnetwork for direct ingress. Format: `projects/{project_id}/regions/{region}/subnetworks/{subnetwork_id}`", -"type": "string" -} -}, -"type": "object" -}, "DropInfo": { "description": "Details of the final state \"drop\" and associated resource.", "id": "DropInfo", @@ -4264,10 +4241,6 @@ false "$ref": "DirectVpcEgressConnectionInfo", "description": "Display information of a serverless direct VPC egress connection." }, -"directVpcIngressConnection": { -"$ref": "DirectVpcIngressConnectionInfo", -"description": "Display information of a serverless direct VPC ingress connection." -}, "dmsPrivateConnection": { "$ref": "PrivateConnectionInfo", "description": "Display information of a DMS Private Connection." @@ -4414,7 +4387,6 @@ false "ARRIVE_AT_INTERCONNECT_ATTACHMENT", "ARRIVE_AT_VPC_CONNECTOR", "ARRIVE_AT_GKE_POD", -"ARRIVE_AT_DIRECT_VPC_INGRESS_CONNECTION", "DIRECT_VPC_EGRESS_CONNECTION", "SERVERLESS_EXTERNAL_CONNECTION", "NGFW_PACKET_INSPECTION", @@ -4480,7 +4452,6 @@ false, false, false, false, -false, false ], "enumDescriptions": [ @@ -4518,7 +4489,6 @@ false "Forwarding state: arriving at an interconnect attachment.", "Forwarding state: arriving at a VPC connector.", "Forwarding state: arriving at a GKE Pod.", -"Forwarding state: arriving at a direct VPC ingress connection.", "Forwarding state: for packets originating from a serverless endpoint forwarded through Direct VPC egress.", "Forwarding state: for packets originating from a serverless endpoint forwarded through public (external) connectivity.", "Forwarding state: Layer 7 packet inspection by the firewall endpoint based on the configured security profile group.", From 98b4abca47754c9478c3beb757e883d0be4fe5d5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:38 +0000 Subject: [PATCH 30/41] feat(ondemandscanning): update the api #### ondemandscanning:v1 The following keys were added: - schemas.PackageData.properties.licenses.deprecated (Total Keys: 1) #### ondemandscanning:v1beta1 The following keys were added: - schemas.PackageData.properties.licenses.deprecated (Total Keys: 1) --- docs/dyn/ondemandscanning_v1.projects.locations.scans.html | 2 +- .../ondemandscanning_v1beta1.projects.locations.scans.html | 2 +- .../discovery_cache/documents/ondemandscanning.v1.json | 5 +++-- .../discovery_cache/documents/ondemandscanning.v1beta1.json | 5 +++-- 4 files changed, 8 insertions(+), 6 deletions(-) diff --git a/docs/dyn/ondemandscanning_v1.projects.locations.scans.html b/docs/dyn/ondemandscanning_v1.projects.locations.scans.html index 73b0fb0027..9bb0a3ff4a 100644 --- a/docs/dyn/ondemandscanning_v1.projects.locations.scans.html +++ b/docs/dyn/ondemandscanning_v1.projects.locations.scans.html @@ -174,7 +174,7 @@

Method Details

"diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. }, - "licenses": [ # The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos, it will be stored there, as one source can have multiple binaries with different licenses. + "licenses": [ # Deprecated: Top-level licenses is not persisted in the legacy Packages table. Licenses are captured in BinarySourceInfo or PackagesV2. "A String", ], "maintainer": { # The maintainer of the package. diff --git a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html index 57eb0aefbe..2cb4175a32 100644 --- a/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html +++ b/docs/dyn/ondemandscanning_v1beta1.projects.locations.scans.html @@ -173,7 +173,7 @@

Method Details

"diffId": "A String", # The diff ID (sha256 hash) of the layer in the container image. "index": 42, # The index of the layer in the container image. }, - "licenses": [ # The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos, it will be stored there, as one source can have multiple binaries with different licenses. + "licenses": [ # Deprecated: Top-level licenses is not persisted in the legacy Packages table. Licenses are captured in BinarySourceInfo or PackagesV2. "A String", ], "maintainer": { # The maintainer of the package. diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json index bebb18c721..6a0ff519b2 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1.json @@ -344,7 +344,7 @@ } } }, -"revision": "20260918", +"revision": "20260925", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AISkillAnalysisOccurrence": { @@ -2533,7 +2533,8 @@ "description": "Deprecated: Layer details are captured per file location in FileLocation.layer_details. Top-level layer details is not persisted." }, "licenses": { -"description": "The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos, it will be stored there, as one source can have multiple binaries with different licenses.", +"deprecated": true, +"description": "Deprecated: Top-level licenses is not persisted in the legacy Packages table. Licenses are captured in BinarySourceInfo or PackagesV2.", "items": { "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json index c3fdd0a7dc..7eac86a5fd 100644 --- a/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/ondemandscanning.v1beta1.json @@ -344,7 +344,7 @@ } } }, -"revision": "20260918", +"revision": "20260925", "rootUrl": "https://ondemandscanning.googleapis.com/", "schemas": { "AISkillAnalysisOccurrence": { @@ -2528,7 +2528,8 @@ "description": "Deprecated: Layer details are captured per file location in FileLocation.layer_details. Top-level layer details is not persisted." }, "licenses": { -"description": "The list of licenses found that are related to a given package. Note that licenses may also be stored on the BinarySourceInfo. If there is no BinarySourceInfo (because there's no concept of source vs binary), then it will be stored here, while if there are BinarySourceInfos, it will be stored there, as one source can have multiple binaries with different licenses.", +"deprecated": true, +"description": "Deprecated: Top-level licenses is not persisted in the legacy Packages table. Licenses are captured in BinarySourceInfo or PackagesV2.", "items": { "type": "string" }, From e0617a3f86e37692cb0b784e58aae3ad156cd661 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:39 +0000 Subject: [PATCH 31/41] feat(parametermanager): update the api #### parametermanager:v1 The following keys were deleted: - schemas.RenderParameterVersionResponse.properties.parameterVersion.readOnly (Total Keys: 1) - schemas.RenderParameterVersionResponse.properties.renderedPayload.readOnly (Total Keys: 1) - schemas.RenderTemplateVersionResponse.properties.parameterVersion.readOnly (Total Keys: 1) - schemas.RenderTemplateVersionResponse.properties.renderedPayload.readOnly (Total Keys: 1) - schemas.RenderTemplateVersionResponse.properties.templateFormat.readOnly (Total Keys: 1) --- ...ager_v1.projects.locations.parameters.html | 50 +++++------ ...rojects.locations.parameters.versions.html | 82 +++++++++---------- ...projects.locations.templates.versions.html | 8 +- .../documents/parametermanager.v1.json | 45 +++++----- 4 files changed, 90 insertions(+), 95 deletions(-) diff --git a/docs/dyn/parametermanager_v1.projects.locations.parameters.html b/docs/dyn/parametermanager_v1.projects.locations.parameters.html index 3b94cf160b..995601ce3e 100644 --- a/docs/dyn/parametermanager_v1.projects.locations.parameters.html +++ b/docs/dyn/parametermanager_v1.projects.locations.parameters.html @@ -116,21 +116,21 @@

Method Details

The object takes the form of: { # Message describing Parameter resource - "createTime": "A String", # Output only. [Output only] Create time stamp + "createTime": "A String", # Output only. Create time stamp "format": "A String", # Optional. Specifies the format of a Parameter. "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. - "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource. + "name": "A String", # Identifier. The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Policy member strings of a Google Cloud resource. "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` }, "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, - "updateTime": "A String", # Output only. [Output only] Update time stamp + "updateTime": "A String", # Output only. Update time stamp } parameterId: string, Required. Id of the Parameter resource @@ -144,21 +144,21 @@

Method Details

An object of the form: { # Message describing Parameter resource - "createTime": "A String", # Output only. [Output only] Create time stamp + "createTime": "A String", # Output only. Create time stamp "format": "A String", # Optional. Specifies the format of a Parameter. "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. - "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource. + "name": "A String", # Identifier. The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Policy member strings of a Google Cloud resource. "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` }, "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, - "updateTime": "A String", # Output only. [Output only] Update time stamp + "updateTime": "A String", # Output only. Update time stamp }
@@ -196,21 +196,21 @@

Method Details

An object of the form: { # Message describing Parameter resource - "createTime": "A String", # Output only. [Output only] Create time stamp + "createTime": "A String", # Output only. Create time stamp "format": "A String", # Optional. Specifies the format of a Parameter. "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. - "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource. + "name": "A String", # Identifier. The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Policy member strings of a Google Cloud resource. "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` }, "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, - "updateTime": "A String", # Output only. [Output only] Update time stamp + "updateTime": "A String", # Output only. Update time stamp } @@ -236,21 +236,21 @@

Method Details

"nextPageToken": "A String", # A token identifying a page of results the server should return. "parameters": [ # The list of Parameters { # Message describing Parameter resource - "createTime": "A String", # Output only. [Output only] Create time stamp + "createTime": "A String", # Output only. Create time stamp "format": "A String", # Optional. Specifies the format of a Parameter. "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. - "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource. + "name": "A String", # Identifier. The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Policy member strings of a Google Cloud resource. "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` }, "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, - "updateTime": "A String", # Output only. [Output only] Update time stamp + "updateTime": "A String", # Output only. Update time stamp }, ], "unreachable": [ # Unordered list. Locations that could not be reached. @@ -278,26 +278,26 @@

Method Details

Updates a single Parameter.
 
 Args:
-  name: string, Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. (required)
+  name: string, Identifier. The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Message describing Parameter resource
-  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "createTime": "A String", # Output only. Create time stamp
   "format": "A String", # Optional. Specifies the format of a Parameter.
   "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`.
   "labels": { # Optional. Labels as key value pairs
     "a_key": "A String",
   },
-  "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`.
-  "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource.
+  "name": "A String", # Identifier. The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`.
+  "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Policy member strings of a Google Cloud resource.
     "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter`
     "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5`
   },
   "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource.
     "a_key": "A String",
   },
-  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "updateTime": "A String", # Output only. Update time stamp
 }
 
   requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@@ -311,21 +311,21 @@ 

Method Details

An object of the form: { # Message describing Parameter resource - "createTime": "A String", # Output only. [Output only] Create time stamp + "createTime": "A String", # Output only. Create time stamp "format": "A String", # Optional. Specifies the format of a Parameter. "kmsKey": "A String", # Optional. Customer managed encryption key (CMEK) to use for encrypting the Parameter Versions. If not set, the default Google-managed encryption key will be used. Cloud KMS CryptoKeys must reside in the same location as the Parameter. The expected format is `projects/*/locations/*/keyRings/*/cryptoKeys/*`. "labels": { # Optional. Labels as key value pairs "a_key": "A String", }, - "name": "A String", # Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. - "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. [Output-only] policy member strings of a Google Cloud resource. + "name": "A String", # Identifier. The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`. + "policyMember": { # Output-only policy member strings of a Google Cloud resource's built-in identity. # Output only. Policy member strings of a Google Cloud resource. "iamPolicyNamePrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by user-assigned name (https://google.aip.dev/122). If a resource is deleted and recreated with the same name, the binding will be applicable to the new resource. Example: `principal://parametermanager.googleapis.com/projects/12345/name/locations/us-central1-a/parameters/my-parameter` "iamPolicyUidPrincipal": "A String", # Output only. IAM policy binding member referring to a Google Cloud resource by system-assigned unique identifier (https://google.aip.dev/148#uid). If a resource is deleted and recreated with the same name, the binding will not be applicable to the new resource Example: `principal://parametermanager.googleapis.com/projects/12345/uid/locations/us-central1-a/parameters/a918fed5` }, "tags": { # Optional. Input only. Immutable. Tag keys and tag values that are bound to this Parameter. You must represent each item in the map as: `"" : ""`. For example, a single resource can have the following tags: ``` "123/environment": "production", "123/costCenter": "marketing", ``` Tags are used to organize and group resources. Tags can be used to control policy evaluation for the resource. "a_key": "A String", }, - "updateTime": "A String", # Output only. [Output only] Update time stamp + "updateTime": "A String", # Output only. Update time stamp }
diff --git a/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html b/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html index 7113173479..825b408881 100644 --- a/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html +++ b/docs/dyn/parametermanager_v1.projects.locations.parameters.versions.html @@ -114,16 +114,16 @@

Method Details

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

Method Details

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

Method Details

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

Method Details

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

Method Details

Updates a single ParameterVersion.
 
 Args:
-  name: string, Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`. (required)
+  name: string, Identifier. The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`. (required)
   body: object, The request body.
     The object takes the form of:
 
 { # Message describing ParameterVersion resource
-  "checksumSource": "A String", # Optional. Output only. [Output only] The source of the checksum.
-  "createTime": "A String", # Output only. [Output only] Create time stamp
+  "checksumSource": "A String", # Optional. Output only. The source of the checksum.
+  "createTime": "A String", # Output only. Create time stamp
   "disabled": True or False, # Optional. Disabled boolean to determine if a ParameterVersion acts as a metadata only resource (payload is never returned if disabled is true). If true any calls will always default to BASIC view even if the user explicitly passes FULL view as part of the request. A render call on a disabled resource fails with an error. Default value is False.
-  "kmsKeyVersion": "A String", # Optional. Output only. [Output only] The resource name of the KMS key version used to encrypt the ParameterVersion payload. This field is populated only if the Parameter resource has customer managed encryption key (CMEK) configured.
-  "name": "A String", # Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`.
+  "kmsKeyVersion": "A String", # Optional. Output only. The resource name of the KMS key version used to encrypt the ParameterVersion payload. This field is populated only if the Parameter resource has customer managed encryption key (CMEK) configured.
+  "name": "A String", # Identifier. The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`.
   "payload": { # Message for storing a ParameterVersion resource's payload data # Required. Immutable. Payload content of a ParameterVersion resource. This is only returned when the request provides the View value of FULL (default for GET request).
     "data": "A String", # Required. bytes data for storing payload.
-    "dataCrc32c": "A String", # Optional. [Optional] The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum.
+    "dataCrc32c": "A String", # Optional. The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum.
   },
-  "updateTime": "A String", # Output only. [Output only] Update time stamp
+  "updateTime": "A String", # Output only. Update time stamp
 }
 
   requestId: string, Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).
@@ -289,16 +289,16 @@ 

Method Details

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

Method Details

Returns: An object of the form: - { # Message describing RenderParameterVersionResponse resource - "parameterVersion": "A String", # Output only. Resource identifier of a ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`. + { # Message describing response of the `RenderParameterVersion` method + "parameterVersion": "A String", # Resource identifier of a ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`. "payload": { # Message for storing a ParameterVersion resource's payload data # Payload content of a ParameterVersion resource. "data": "A String", # Required. bytes data for storing payload. - "dataCrc32c": "A String", # Optional. [Optional] The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum. + "dataCrc32c": "A String", # Optional. The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum. }, - "renderedPayload": "A String", # Output only. Server generated rendered version of the user provided payload data (ParameterVersionPayload) which has substitutions of all (if any) references to a SecretManager SecretVersion resources. This substitution only works for a Parameter which is in JSON or YAML format. + "renderedPayload": "A String", # Server generated rendered version of the user provided payload data (ParameterVersionPayload) which has substitutions of all (if any) references to a SecretManager SecretVersion resources. This substitution only works for a Parameter which is in JSON or YAML format. } diff --git a/docs/dyn/parametermanager_v1.projects.locations.templates.versions.html b/docs/dyn/parametermanager_v1.projects.locations.templates.versions.html index 7f905cbb20..496c019664 100644 --- a/docs/dyn/parametermanager_v1.projects.locations.templates.versions.html +++ b/docs/dyn/parametermanager_v1.projects.locations.templates.versions.html @@ -299,13 +299,13 @@

Method Details

Returns: An object of the form: - { # Message describing RenderTemplateVersionResponse resource - "parameterVersion": "A String", # Output only. The resource name of the ParameterVersion used to render the template version in the format `projects/*/locations/*/parameters/*/versions/*`. + { # Message describing response for `RenderTemplateVersion` method + "parameterVersion": "A String", # The resource name of the ParameterVersion used to render the template version in the format `projects/*/locations/*/parameters/*/versions/*`. "payload": { # Message for storing a TemplateVersion resource's payload data # Payload content of a TemplateVersion resource. "data": "A String", # Required. bytes data for storing payload. }, - "renderedPayload": "A String", # Output only. Server generated rendered version of the user provided payload data (TemplateVersionPayload) which has all the variables resolved using the provided parameter version. - "templateFormat": "A String", # Output only. Format of the template version. + "renderedPayload": "A String", # Server generated rendered version of the user provided payload data (TemplateVersionPayload) which has all the variables resolved using the provided parameter version. + "templateFormat": "A String", # Format of the template version. "templateVersion": "A String", # Resource identifier of a TemplateVersion in the format `projects/*/locations/*/templates/*/versions/*`. } diff --git a/googleapiclient/discovery_cache/documents/parametermanager.v1.json b/googleapiclient/discovery_cache/documents/parametermanager.v1.json index f602659601..5e1e61abdb 100644 --- a/googleapiclient/discovery_cache/documents/parametermanager.v1.json +++ b/googleapiclient/discovery_cache/documents/parametermanager.v1.json @@ -566,7 +566,7 @@ ], "parameters": { "name": { -"description": "Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`.", +"description": "Identifier. The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/parameters/[^/]+$", "required": true, @@ -763,7 +763,7 @@ ], "parameters": { "name": { -"description": "Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`.", +"description": "Identifier. The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/parameters/[^/]+/versions/[^/]+$", "required": true, @@ -1237,7 +1237,7 @@ } } }, -"revision": "20260831", +"revision": "20260923", "rootUrl": "https://parametermanager.googleapis.com/", "schemas": { "Empty": { @@ -1403,7 +1403,7 @@ "id": "Parameter", "properties": { "createTime": { -"description": "Output only. [Output only] Create time stamp", +"description": "Output only. Create time stamp", "format": "google-datetime", "readOnly": true, "type": "string" @@ -1436,12 +1436,12 @@ "type": "object" }, "name": { -"description": "Identifier. [Output only] The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`.", +"description": "Identifier. The resource name of the Parameter in the format `projects/*/locations/*/parameters/*`.", "type": "string" }, "policyMember": { "$ref": "ResourcePolicyMember", -"description": "Output only. [Output-only] policy member strings of a Google Cloud resource.", +"description": "Output only. Policy member strings of a Google Cloud resource.", "readOnly": true }, "tags": { @@ -1452,7 +1452,7 @@ "type": "object" }, "updateTime": { -"description": "Output only. [Output only] Update time stamp", +"description": "Output only. Update time stamp", "format": "google-datetime", "readOnly": true, "type": "string" @@ -1465,7 +1465,7 @@ "id": "ParameterVersion", "properties": { "checksumSource": { -"description": "Optional. Output only. [Output only] The source of the checksum.", +"description": "Optional. Output only. The source of the checksum.", "enum": [ "CHECKSUM_SOURCE_UNSPECIFIED", "SERVER_GENERATED", @@ -1480,7 +1480,7 @@ "type": "string" }, "createTime": { -"description": "Output only. [Output only] Create time stamp", +"description": "Output only. Create time stamp", "format": "google-datetime", "readOnly": true, "type": "string" @@ -1490,12 +1490,12 @@ "type": "boolean" }, "kmsKeyVersion": { -"description": "Optional. Output only. [Output only] The resource name of the KMS key version used to encrypt the ParameterVersion payload. This field is populated only if the Parameter resource has customer managed encryption key (CMEK) configured.", +"description": "Optional. Output only. The resource name of the KMS key version used to encrypt the ParameterVersion payload. This field is populated only if the Parameter resource has customer managed encryption key (CMEK) configured.", "readOnly": true, "type": "string" }, "name": { -"description": "Identifier. [Output only] The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`.", +"description": "Identifier. The resource name of the ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`.", "type": "string" }, "payload": { @@ -1503,7 +1503,7 @@ "description": "Required. Immutable. Payload content of a ParameterVersion resource. This is only returned when the request provides the View value of FULL (default for GET request)." }, "updateTime": { -"description": "Output only. [Output only] Update time stamp", +"description": "Output only. Update time stamp", "format": "google-datetime", "readOnly": true, "type": "string" @@ -1521,7 +1521,7 @@ "type": "string" }, "dataCrc32c": { -"description": "Optional. [Optional] The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum.", +"description": "Optional. The integrity checksum of the payload. If provided, the server will verify that the checksum matches the payload. If not provided, the server will generate the checksum.", "format": "int64", "type": "string" } @@ -1529,12 +1529,11 @@ "type": "object" }, "RenderParameterVersionResponse": { -"description": "Message describing RenderParameterVersionResponse resource", +"description": "Message describing response of the `RenderParameterVersion` method", "id": "RenderParameterVersionResponse", "properties": { "parameterVersion": { -"description": "Output only. Resource identifier of a ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`.", -"readOnly": true, +"description": "Resource identifier of a ParameterVersion in the format `projects/*/locations/*/parameters/*/versions/*`.", "type": "string" }, "payload": { @@ -1542,21 +1541,19 @@ "description": "Payload content of a ParameterVersion resource." }, "renderedPayload": { -"description": "Output only. Server generated rendered version of the user provided payload data (ParameterVersionPayload) which has substitutions of all (if any) references to a SecretManager SecretVersion resources. This substitution only works for a Parameter which is in JSON or YAML format.", +"description": "Server generated rendered version of the user provided payload data (ParameterVersionPayload) which has substitutions of all (if any) references to a SecretManager SecretVersion resources. This substitution only works for a Parameter which is in JSON or YAML format.", "format": "byte", -"readOnly": true, "type": "string" } }, "type": "object" }, "RenderTemplateVersionResponse": { -"description": "Message describing RenderTemplateVersionResponse resource", +"description": "Message describing response for `RenderTemplateVersion` method", "id": "RenderTemplateVersionResponse", "properties": { "parameterVersion": { -"description": "Output only. The resource name of the ParameterVersion used to render the template version in the format `projects/*/locations/*/parameters/*/versions/*`.", -"readOnly": true, +"description": "The resource name of the ParameterVersion used to render the template version in the format `projects/*/locations/*/parameters/*/versions/*`.", "type": "string" }, "payload": { @@ -1564,13 +1561,12 @@ "description": "Payload content of a TemplateVersion resource." }, "renderedPayload": { -"description": "Output only. Server generated rendered version of the user provided payload data (TemplateVersionPayload) which has all the variables resolved using the provided parameter version.", +"description": "Server generated rendered version of the user provided payload data (TemplateVersionPayload) which has all the variables resolved using the provided parameter version.", "format": "byte", -"readOnly": true, "type": "string" }, "templateFormat": { -"description": "Output only. Format of the template version.", +"description": "Format of the template version.", "enum": [ "TEMPLATE_FORMAT_UNSPECIFIED", "TEMPLATE_FORMAT_YAML", @@ -1581,7 +1577,6 @@ "YAML format.", "JSON format." ], -"readOnly": true, "type": "string" }, "templateVersion": { From 295a5b23120298c166d06c2fcce10c2b82477e87 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:39 +0000 Subject: [PATCH 32/41] feat(paymentsresellersubscription): update the api #### paymentsresellersubscription:v1 The following keys were added: - schemas.SubscriptionLineItem.properties.planType (Total Keys: 2) --- ...rsubscription_v1.partners.subscriptions.html | 10 ++++++++++ ...ion_v1.partners.subscriptions.lineItems.html | 2 ++ ...ersubscription_v1.partners.userSessions.html | 1 + .../paymentsresellersubscription.v1.json | 17 ++++++++++++++++- 4 files changed, 29 insertions(+), 1 deletion(-) diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html index d391e4ca46..faf868e77e 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.html @@ -191,6 +191,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. @@ -343,6 +344,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. @@ -488,6 +490,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. @@ -654,6 +657,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. @@ -841,6 +845,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. @@ -987,6 +992,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. @@ -1139,6 +1145,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. @@ -1304,6 +1311,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. @@ -1464,6 +1472,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. @@ -1623,6 +1632,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.lineItems.html b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.lineItems.html index 4aa48bb3f1..50e2d17df4 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.lineItems.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.subscriptions.lineItems.html @@ -144,6 +144,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. @@ -230,6 +231,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. diff --git a/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html b/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html index 7fcabe3d46..09d4eb2c4a 100644 --- a/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html +++ b/docs/dyn/paymentsresellersubscription_v1.partners.userSessions.html @@ -163,6 +163,7 @@

Method Details

"startTime": "A String", # Required. The start time of the service period. Time is inclusive. }, }, + "planType": "A String", # Optional. Output only. The plan type of the line item. "product": "A String", # Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'. "productPayload": { # Specifies product specific payload. # Optional. Product specific payload for this line item. "googleHomePayload": { # Payload specific for Google Home products. # Payload specific to Google Home products. diff --git a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json index 011a9a3f51..85b075d608 100644 --- a/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json +++ b/googleapiclient/discovery_cache/documents/paymentsresellersubscription.v1.json @@ -591,7 +591,7 @@ } } }, -"revision": "20260924", +"revision": "20260929", "rootUrl": "https://paymentsresellersubscription.googleapis.com/", "schemas": { "Amount": { @@ -1623,6 +1623,21 @@ "description": "Output only. Details only set for a ONE_TIME recurrence line item.", "readOnly": true }, +"planType": { +"description": "Optional. Output only. The plan type of the line item.", +"enum": [ +"LINE_ITEM_PLAN_TYPE_UNSPECIFIED", +"LINE_ITEM_PLAN_TYPE_BASE", +"LINE_ITEM_PLAN_TYPE_ADDON" +], +"enumDescriptions": [ +"The line item plan type is unspecified.", +"The line item is the base plan in the subscription.", +"The line item is an add-on to the subscription." +], +"readOnly": true, +"type": "string" +}, "product": { "description": "Required. Product resource name that identifies the product associated with this line item. The format is 'partners/{partner_id}/products/{product_id}'.", "type": "string" From 87029855fe1ee8d30aeb7ec7b157a82afeaee313 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:39 +0000 Subject: [PATCH 33/41] feat(pubsub): update the api #### pubsub:v1 The following keys were added: - schemas.BigtableConfig.properties.columnFamilyMapping.$ref (Total Keys: 1) - schemas.ColumnFamilyMapping (Total Keys: 4) - schemas.DelimitedKey (Total Keys: 6) - schemas.RowKeySchema (Total Keys: 2) --- .../dyn/pubsub_v1.projects.subscriptions.html | 72 +++++++++++++++++-- .../discovery_cache/documents/pubsub.v1.json | 48 ++++++++++++- 2 files changed, 112 insertions(+), 8 deletions(-) diff --git a/docs/dyn/pubsub_v1.projects.subscriptions.html b/docs/dyn/pubsub_v1.projects.subscriptions.html index 1ace669007..4aea87b2b2 100644 --- a/docs/dyn/pubsub_v1.projects.subscriptions.html +++ b/docs/dyn/pubsub_v1.projects.subscriptions.html @@ -179,8 +179,18 @@

Method Details

"useTopicSchema": True or False, # Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be enabled at the same time. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column. }, - "bigtableConfig": { # Configuration for a Bigtable subscription. The Pub/Sub message will be written to a Bigtable row as follows: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. + "bigtableConfig": { # Configuration for a Bigtable subscription, which will write a Pub/Sub message to a Bigtable row. See the ColumnFamilyMapping documentation below for details on how the row keys and columns will be written. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. "appProfileId": "A String", # Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing. + "columnFamilyMapping": { # Configuration for writing a Pub/Sub message to a Bigtable row with a user-defined key and writing to column families. If this field is set: - The subscription messages must be formatted as JSON. - The row key mapping is configured in the `key_definition` section. - The top-level fields will be written either: - By default, they will be written to the `data` column family with the field name as the column qualifier. - But if the field name matches an existing column family (except for the default `data` column), then that field will be written to that column family, either as a scalar or its next level nested fields if it's a JSON object. - The cell timestamp will be the message publish timestamp. If the field is not set, the default behavior is to write: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set. + "delimitedKey": { # Row key definition based on fields from the message. # Optional. If set, the row key is constructed from the given key fields and delimiter. All key fields must be present in the message; otherwise, the message remains in the subscription backlog. + "delimiter": "A String", # Optional. Byte sequence used to delimit concatenated fields. Must be specified if multiple key fields are used. The delimiter must contain at least 1 character and at most 50 characters. + "keyFields": [ # Optional. The key fields to construct from the row key. The fields must be present in the message as a top-level field, i.e. JSON path expressions will not traverse into nested objects. + "A String", + ], + }, + "rowKeySchema": { # Row key definition that reads the input message fields based on the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. # Optional. If set, the row key is constructed from the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. + }, + }, "serviceAccountEmail": "A String", # Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The unique name of the table to write messages to. Values are of the form `projects//instances//tables/`. @@ -293,8 +303,18 @@

Method Details

"useTopicSchema": True or False, # Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be enabled at the same time. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column. }, - "bigtableConfig": { # Configuration for a Bigtable subscription. The Pub/Sub message will be written to a Bigtable row as follows: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. + "bigtableConfig": { # Configuration for a Bigtable subscription, which will write a Pub/Sub message to a Bigtable row. See the ColumnFamilyMapping documentation below for details on how the row keys and columns will be written. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. "appProfileId": "A String", # Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing. + "columnFamilyMapping": { # Configuration for writing a Pub/Sub message to a Bigtable row with a user-defined key and writing to column families. If this field is set: - The subscription messages must be formatted as JSON. - The row key mapping is configured in the `key_definition` section. - The top-level fields will be written either: - By default, they will be written to the `data` column family with the field name as the column qualifier. - But if the field name matches an existing column family (except for the default `data` column), then that field will be written to that column family, either as a scalar or its next level nested fields if it's a JSON object. - The cell timestamp will be the message publish timestamp. If the field is not set, the default behavior is to write: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set. + "delimitedKey": { # Row key definition based on fields from the message. # Optional. If set, the row key is constructed from the given key fields and delimiter. All key fields must be present in the message; otherwise, the message remains in the subscription backlog. + "delimiter": "A String", # Optional. Byte sequence used to delimit concatenated fields. Must be specified if multiple key fields are used. The delimiter must contain at least 1 character and at most 50 characters. + "keyFields": [ # Optional. The key fields to construct from the row key. The fields must be present in the message as a top-level field, i.e. JSON path expressions will not traverse into nested objects. + "A String", + ], + }, + "rowKeySchema": { # Row key definition that reads the input message fields based on the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. # Optional. If set, the row key is constructed from the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. + }, + }, "serviceAccountEmail": "A String", # Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The unique name of the table to write messages to. Values are of the form `projects//instances//tables/`. @@ -450,8 +470,18 @@

Method Details

"useTopicSchema": True or False, # Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be enabled at the same time. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column. }, - "bigtableConfig": { # Configuration for a Bigtable subscription. The Pub/Sub message will be written to a Bigtable row as follows: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. + "bigtableConfig": { # Configuration for a Bigtable subscription, which will write a Pub/Sub message to a Bigtable row. See the ColumnFamilyMapping documentation below for details on how the row keys and columns will be written. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. "appProfileId": "A String", # Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing. + "columnFamilyMapping": { # Configuration for writing a Pub/Sub message to a Bigtable row with a user-defined key and writing to column families. If this field is set: - The subscription messages must be formatted as JSON. - The row key mapping is configured in the `key_definition` section. - The top-level fields will be written either: - By default, they will be written to the `data` column family with the field name as the column qualifier. - But if the field name matches an existing column family (except for the default `data` column), then that field will be written to that column family, either as a scalar or its next level nested fields if it's a JSON object. - The cell timestamp will be the message publish timestamp. If the field is not set, the default behavior is to write: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set. + "delimitedKey": { # Row key definition based on fields from the message. # Optional. If set, the row key is constructed from the given key fields and delimiter. All key fields must be present in the message; otherwise, the message remains in the subscription backlog. + "delimiter": "A String", # Optional. Byte sequence used to delimit concatenated fields. Must be specified if multiple key fields are used. The delimiter must contain at least 1 character and at most 50 characters. + "keyFields": [ # Optional. The key fields to construct from the row key. The fields must be present in the message as a top-level field, i.e. JSON path expressions will not traverse into nested objects. + "A String", + ], + }, + "rowKeySchema": { # Row key definition that reads the input message fields based on the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. # Optional. If set, the row key is constructed from the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. + }, + }, "serviceAccountEmail": "A String", # Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The unique name of the table to write messages to. Values are of the form `projects//instances//tables/`. @@ -611,8 +641,18 @@

Method Details

"useTopicSchema": True or False, # Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be enabled at the same time. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column. }, - "bigtableConfig": { # Configuration for a Bigtable subscription. The Pub/Sub message will be written to a Bigtable row as follows: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. + "bigtableConfig": { # Configuration for a Bigtable subscription, which will write a Pub/Sub message to a Bigtable row. See the ColumnFamilyMapping documentation below for details on how the row keys and columns will be written. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. "appProfileId": "A String", # Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing. + "columnFamilyMapping": { # Configuration for writing a Pub/Sub message to a Bigtable row with a user-defined key and writing to column families. If this field is set: - The subscription messages must be formatted as JSON. - The row key mapping is configured in the `key_definition` section. - The top-level fields will be written either: - By default, they will be written to the `data` column family with the field name as the column qualifier. - But if the field name matches an existing column family (except for the default `data` column), then that field will be written to that column family, either as a scalar or its next level nested fields if it's a JSON object. - The cell timestamp will be the message publish timestamp. If the field is not set, the default behavior is to write: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set. + "delimitedKey": { # Row key definition based on fields from the message. # Optional. If set, the row key is constructed from the given key fields and delimiter. All key fields must be present in the message; otherwise, the message remains in the subscription backlog. + "delimiter": "A String", # Optional. Byte sequence used to delimit concatenated fields. Must be specified if multiple key fields are used. The delimiter must contain at least 1 character and at most 50 characters. + "keyFields": [ # Optional. The key fields to construct from the row key. The fields must be present in the message as a top-level field, i.e. JSON path expressions will not traverse into nested objects. + "A String", + ], + }, + "rowKeySchema": { # Row key definition that reads the input message fields based on the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. # Optional. If set, the row key is constructed from the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. + }, + }, "serviceAccountEmail": "A String", # Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The unique name of the table to write messages to. Values are of the form `projects//instances//tables/`. @@ -811,8 +851,18 @@

Method Details

"useTopicSchema": True or False, # Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be enabled at the same time. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column. }, - "bigtableConfig": { # Configuration for a Bigtable subscription. The Pub/Sub message will be written to a Bigtable row as follows: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. + "bigtableConfig": { # Configuration for a Bigtable subscription, which will write a Pub/Sub message to a Bigtable row. See the ColumnFamilyMapping documentation below for details on how the row keys and columns will be written. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. "appProfileId": "A String", # Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing. + "columnFamilyMapping": { # Configuration for writing a Pub/Sub message to a Bigtable row with a user-defined key and writing to column families. If this field is set: - The subscription messages must be formatted as JSON. - The row key mapping is configured in the `key_definition` section. - The top-level fields will be written either: - By default, they will be written to the `data` column family with the field name as the column qualifier. - But if the field name matches an existing column family (except for the default `data` column), then that field will be written to that column family, either as a scalar or its next level nested fields if it's a JSON object. - The cell timestamp will be the message publish timestamp. If the field is not set, the default behavior is to write: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set. + "delimitedKey": { # Row key definition based on fields from the message. # Optional. If set, the row key is constructed from the given key fields and delimiter. All key fields must be present in the message; otherwise, the message remains in the subscription backlog. + "delimiter": "A String", # Optional. Byte sequence used to delimit concatenated fields. Must be specified if multiple key fields are used. The delimiter must contain at least 1 character and at most 50 characters. + "keyFields": [ # Optional. The key fields to construct from the row key. The fields must be present in the message as a top-level field, i.e. JSON path expressions will not traverse into nested objects. + "A String", + ], + }, + "rowKeySchema": { # Row key definition that reads the input message fields based on the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. # Optional. If set, the row key is constructed from the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. + }, + }, "serviceAccountEmail": "A String", # Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The unique name of the table to write messages to. Values are of the form `projects//instances//tables/`. @@ -927,8 +977,18 @@

Method Details

"useTopicSchema": True or False, # Optional. When true, use the topic's schema as the columns to write to in BigQuery, if it exists. `use_topic_schema` and `use_table_schema` cannot be enabled at the same time. "writeMetadata": True or False, # Optional. When true, write the subscription name, message_id, publish_time, attributes, and ordering_key to additional columns in the table. The subscription name, message_id, and publish_time fields are put in their own columns while all other message properties (other than data) are written to a JSON object in the attributes column. }, - "bigtableConfig": { # Configuration for a Bigtable subscription. The Pub/Sub message will be written to a Bigtable row as follows: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. + "bigtableConfig": { # Configuration for a Bigtable subscription, which will write a Pub/Sub message to a Bigtable row. See the ColumnFamilyMapping documentation below for details on how the row keys and columns will be written. # Optional. If delivery to Bigtable is used with this subscription, this field is used to configure it. "appProfileId": "A String", # Optional. The app profile to use for the Bigtable writes. If not specified, the "default" application profile will be used. The app profile must use single-cluster routing. + "columnFamilyMapping": { # Configuration for writing a Pub/Sub message to a Bigtable row with a user-defined key and writing to column families. If this field is set: - The subscription messages must be formatted as JSON. - The row key mapping is configured in the `key_definition` section. - The top-level fields will be written either: - By default, they will be written to the `data` column family with the field name as the column qualifier. - But if the field name matches an existing column family (except for the default `data` column), then that field will be written to that column family, either as a scalar or its next level nested fields if it's a JSON object. - The cell timestamp will be the message publish timestamp. If the field is not set, the default behavior is to write: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp. # Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set. + "delimitedKey": { # Row key definition based on fields from the message. # Optional. If set, the row key is constructed from the given key fields and delimiter. All key fields must be present in the message; otherwise, the message remains in the subscription backlog. + "delimiter": "A String", # Optional. Byte sequence used to delimit concatenated fields. Must be specified if multiple key fields are used. The delimiter must contain at least 1 character and at most 50 characters. + "keyFields": [ # Optional. The key fields to construct from the row key. The fields must be present in the message as a top-level field, i.e. JSON path expressions will not traverse into nested objects. + "A String", + ], + }, + "rowKeySchema": { # Row key definition that reads the input message fields based on the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. # Optional. If set, the row key is constructed from the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. + }, + }, "serviceAccountEmail": "A String", # Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. "state": "A String", # Output only. An output-only field that indicates whether or not the subscription can receive messages. "table": "A String", # Optional. The unique name of the table to write messages to. Values are of the form `projects//instances//tables/`. diff --git a/googleapiclient/discovery_cache/documents/pubsub.v1.json b/googleapiclient/discovery_cache/documents/pubsub.v1.json index 0d575903dd..6e80f6d3a9 100644 --- a/googleapiclient/discovery_cache/documents/pubsub.v1.json +++ b/googleapiclient/discovery_cache/documents/pubsub.v1.json @@ -1798,7 +1798,7 @@ } } }, -"revision": "20260915", +"revision": "20260924", "rootUrl": "https://pubsub.googleapis.com/", "schemas": { "AIInference": { @@ -2079,13 +2079,17 @@ "type": "object" }, "BigtableConfig": { -"description": "Configuration for a Bigtable subscription. The Pub/Sub message will be written to a Bigtable row as follows: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp.", +"description": "Configuration for a Bigtable subscription, which will write a Pub/Sub message to a Bigtable row. See the ColumnFamilyMapping documentation below for details on how the row keys and columns will be written.", "id": "BigtableConfig", "properties": { "appProfileId": { "description": "Optional. The app profile to use for the Bigtable writes. If not specified, the \"default\" application profile will be used. The app profile must use single-cluster routing.", "type": "string" }, +"columnFamilyMapping": { +"$ref": "ColumnFamilyMapping", +"description": "Optional. Configuration that allows writing row keys and/or columns based on fields in the input message. The input message format must be JSON if this field is set." +}, "serviceAccountEmail": { "description": "Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used.", "type": "string" @@ -2276,6 +2280,21 @@ }, "type": "object" }, +"ColumnFamilyMapping": { +"description": "Configuration for writing a Pub/Sub message to a Bigtable row with a user-defined key and writing to column families. If this field is set: - The subscription messages must be formatted as JSON. - The row key mapping is configured in the `key_definition` section. - The top-level fields will be written either: - By default, they will be written to the `data` column family with the field name as the column qualifier. - But if the field name matches an existing column family (except for the default `data` column), then that field will be written to that column family, either as a scalar or its next level nested fields if it's a JSON object. - The cell timestamp will be the message publish timestamp. If the field is not set, the default behavior is to write: - row key: subscription name, message ID hash, and message ID delimited by `#`. - columns: message bytes written to a single column family `data` with an empty-string column qualifier. - cell timestamp: the message publish timestamp.", +"id": "ColumnFamilyMapping", +"properties": { +"delimitedKey": { +"$ref": "DelimitedKey", +"description": "Optional. If set, the row key is constructed from the given key fields and delimiter. All key fields must be present in the message; otherwise, the message remains in the subscription backlog." +}, +"rowKeySchema": { +"$ref": "RowKeySchema", +"description": "Optional. If set, the row key is constructed from the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead." +} +}, +"type": "object" +}, "CommitSchemaRequest": { "description": "Request for CommitSchema method.", "id": "CommitSchemaRequest", @@ -2429,6 +2448,25 @@ }, "type": "object" }, +"DelimitedKey": { +"description": "Row key definition based on fields from the message.", +"id": "DelimitedKey", +"properties": { +"delimiter": { +"description": "Optional. Byte sequence used to delimit concatenated fields. Must be specified if multiple key fields are used. The delimiter must contain at least 1 character and at most 50 characters.", +"format": "byte", +"type": "string" +}, +"keyFields": { +"description": "Optional. The key fields to construct from the row key. The fields must be present in the message as a top-level field, i.e. JSON path expressions will not traverse into nested objects.", +"items": { +"type": "string" +}, +"type": "array" +} +}, +"type": "object" +}, "DetachSubscriptionResponse": { "description": "Response for the DetachSubscription method. Reserved for future use.", "id": "DetachSubscriptionResponse", @@ -3010,6 +3048,12 @@ }, "type": "object" }, +"RowKeySchema": { +"description": "Row key definition that reads the input message fields based on the field names of the table's structured row key ({$universe.dns_names.final_documentation_domain}/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead.", +"id": "RowKeySchema", +"properties": {}, +"type": "object" +}, "Schema": { "description": "A schema resource.", "id": "Schema", From ba9ef6ade51a90a7806822d15bf8e0e80999c184 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:39 +0000 Subject: [PATCH 34/41] feat(realtimebidding): update the api #### realtimebidding:v1 The following keys were added: - schemas.PolicyTopicEntry.properties.missingCertificate.deprecated (Total Keys: 1) --- .../realtimebidding_v1.bidders.creatives.html | 10 +-- .../realtimebidding_v1.buyers.creatives.html | 70 +++++++++---------- .../documents/realtimebidding.v1.json | 14 +++- 3 files changed, 51 insertions(+), 43 deletions(-) diff --git a/docs/dyn/realtimebidding_v1.bidders.creatives.html b/docs/dyn/realtimebidding_v1.bidders.creatives.html index 0826f2629a..648bf86273 100644 --- a/docs/dyn/realtimebidding_v1.bidders.creatives.html +++ b/docs/dyn/realtimebidding_v1.bidders.creatives.html @@ -192,7 +192,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -253,7 +253,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -348,7 +348,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -409,7 +409,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -470,7 +470,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], diff --git a/docs/dyn/realtimebidding_v1.buyers.creatives.html b/docs/dyn/realtimebidding_v1.buyers.creatives.html index 41a428d8d6..a86f395d44 100644 --- a/docs/dyn/realtimebidding_v1.buyers.creatives.html +++ b/docs/dyn/realtimebidding_v1.buyers.creatives.html @@ -195,7 +195,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -256,7 +256,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -351,7 +351,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -412,7 +412,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -473,7 +473,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -645,7 +645,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -706,7 +706,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -801,7 +801,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -862,7 +862,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -923,7 +923,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -1088,7 +1088,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -1149,7 +1149,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -1244,7 +1244,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -1305,7 +1305,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -1366,7 +1366,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -1543,7 +1543,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -1604,7 +1604,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -1699,7 +1699,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -1760,7 +1760,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -1821,7 +1821,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2003,7 +2003,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2064,7 +2064,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2159,7 +2159,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2220,7 +2220,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2281,7 +2281,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2465,7 +2465,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2526,7 +2526,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2621,7 +2621,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2682,7 +2682,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2743,7 +2743,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2909,7 +2909,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -2970,7 +2970,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -3065,7 +3065,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -3126,7 +3126,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], @@ -3187,7 +3187,7 @@

Method Details

}, ], "helpCenterUrl": "A String", # URL of the help center article describing this policy topic. - "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776 + "missingCertificate": True or False, # Whether or not the policy topic is missing a certificate. "policyTopic": "A String", # Policy topic this entry refers to. For example, "ALCOHOL", "TRADEMARKS_IN_AD_TEXT", or "DESTINATION_NOT_WORKING". The set of possible policy topics is not fixed for a particular API version and may change at any time. Can be used to filter the response of the creatives.list method }, ], diff --git a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json index 324a531feb..9a5766134e 100644 --- a/googleapiclient/discovery_cache/documents/realtimebidding.v1.json +++ b/googleapiclient/discovery_cache/documents/realtimebidding.v1.json @@ -1333,7 +1333,7 @@ } } }, -"revision": "20260914", +"revision": "20260929", "rootUrl": "https://realtimebidding.googleapis.com/", "schemas": { "ActivatePretargetingConfigRequest": { @@ -2757,12 +2757,19 @@ false "APPROVED", "CERTIFICATE_REQUIRED" ], +"enumDeprecated": [ +false, +false, +false, +false, +true +], "enumDescriptions": [ "Default value that should never be used.", "Creative is pending review.", "Creative cannot serve.", "Creative is approved.", -"Certificates are required for the creative to be served in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776" +"Certificates are required for the creative to be served in some regions." ], "type": "string" }, @@ -2792,7 +2799,8 @@ false "type": "string" }, "missingCertificate": { -"description": "Whether or not the policy topic is missing a certificate. Some policy topics require a certificate to unblock serving in some regions. For more information about creative certification, refer to: https://support.google.com/authorizedbuyers/answer/7450776", +"deprecated": true, +"description": "Whether or not the policy topic is missing a certificate.", "type": "boolean" }, "policyTopic": { From c68458639dad264723258e1e34fcfaa427b8eb51 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:39 +0000 Subject: [PATCH 35/41] feat(solar): update the api #### solar:v1 The following keys were added: - schemas.Obstacle (Total Keys: 5) - schemas.RoofSegmentSizeAndSunshineStats.properties.polygonGeojson (Total Keys: 3) - schemas.SolarPotential.properties.obstacles (Total Keys: 2) --- docs/dyn/solar_v1.buildingInsights.html | 12 +++++ docs/dyn/solar_v1.dataLayers.html | 1 + .../discovery_cache/documents/solar.v1.json | 48 +++++++++++++++++-- 3 files changed, 56 insertions(+), 5 deletions(-) diff --git a/docs/dyn/solar_v1.buildingInsights.html b/docs/dyn/solar_v1.buildingInsights.html index c559f66daf..2f0454ed3c 100644 --- a/docs/dyn/solar_v1.buildingInsights.html +++ b/docs/dyn/solar_v1.buildingInsights.html @@ -94,12 +94,14 @@

Method Details

additionalInsights: string, Optional. A list of additional_insights to be included in the response. (repeated) Allowed values ADDITIONAL_INSIGHTS_UNSPECIFIED - The default value. The default BuildingInsights will be returned. + ROOF_GEOMETRY - Determines whether to include the roof segment polygons and obstacles in the response. If specified, the response will contain a polygon_geojson field in each RoofSegmentSizeAndSunshineStats and the obstacles field in SolarPotential. DETECTED_ARRAYS - Determines whether the response will include the detected arrays. If specified, the `detected_arrays` field will be populated in the response. exactQualityRequired: boolean, Optional. Whether to require exact quality of the imagery. If set to false, the `required_quality` field is interpreted as the minimum required quality, such that HIGH quality imagery may be returned when `required_quality` is set to MEDIUM. If set to true, `required_quality` is interpreted as the exact required quality and only `MEDIUM` quality imagery is returned if `required_quality` is set to `MEDIUM`. experiments: string, Optional. Specifies the pre-GA experiments to enable. Requests using this field are classified as a pre-GA offering under the [Google Maps Platform Service Specific Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). See [launch stage descriptions](https://cloud.google.com/maps-platform/terms/launch-stages) for more details. (repeated) Allowed values EXPERIMENT_UNSPECIFIED - No experiments are specified. EXPANDED_COVERAGE - Expands the geographic region available for querying solar data. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage). + ROOF_GEOMETRY_INSIGHTS - Enables experimental roof geometry data via FindClosestBuildingInsights. Requires `ROOF_GEOMETRY` to be included in the `additional_insights` field. Returns an error if passed to GetDataLayers. location_latitude: number, The latitude in degrees. It must be in the range [-90.0, +90.0]. location_longitude: number, The longitude in degrees. It must be in the range [-180.0, +180.0]. requiredQuality: string, Optional. The minimum quality level allowed in the results. No result with lower quality than this will be returned. Not specifying this is equivalent to restricting to HIGH quality only. @@ -339,6 +341,13 @@

Method Details

"maxArrayAreaMeters2": 3.14, # Size, in square meters, of the maximum array. "maxArrayPanelsCount": 42, # Size of the maximum array - that is, the maximum number of panels that can fit on the roof. "maxSunshineHoursPerYear": 3.14, # Maximum number of sunshine hours received per year, by any point on the roof. Sunshine hours are a measure of the total amount of insolation (energy) received per year. 1 sunshine hour = 1 kWh per kW (where kW refers to kW of capacity under Standard Testing Conditions). + "obstacles": [ # Details for each obstacle detected on the rooftop. An obstacle is defined as any non-buildable area where solar panels cannot be placed due to physical barriers (vents, chimneys, etc.). This field is only populated if ROOF_GEOMETRY is included in the request's FindClosestBuildingInsightsRequest.additional_insights. + { # Details of a single detected obstacle. + "polygonGeojson": { # Output only. A GeoJSON representation of the obstacle. An obstacle is defined as any non-buildable area where solar panels cannot be placed due to physical barriers (vents, chimneys, dormers, etc.). The GeoJSON data must be in RFC 7946 format and represent a Polygon for a single contiguous area. The Polygon will be represented by several loops when it contains holes. Example: { "type": "Polygon", "coordinates": [ [ [-1, -1, 0], [-1, 0, 0], [0, 0, 0], [-1, -1, 0] ] ] } + "a_key": "", # Properties of the object. + }, + }, + ], "panelCapacityWatts": 3.14, # Capacity, in watts, of the panel used in the calculations. "panelHeightMeters": 3.14, # Height, in meters in portrait orientation, of the panel used in the calculations. "panelLifetimeYears": 42, # The expected lifetime, in years, of the solar panels. This is used in the financial calculations. @@ -362,6 +371,9 @@

Method Details

}, "pitchDegrees": 3.14, # Angle of the roof segment relative to the theoretical ground plane. 0 = parallel to the ground, 90 = perpendicular to the ground. "planeHeightAtCenterMeters": 3.14, # The height of the roof segment plane, in meters above sea level, at the point designated by `center`. Together with the pitch, azimuth, and center location, this fully defines the roof segment plane. + "polygonGeojson": { # Output only. A GeoJSON representation of the detailed geometry for the roof segment plane. The polygon represents the physical roof facet, excluding overlapping vegetation and internal cutouts (e.g., courtyards). This field is only populated if ROOF_GEOMETRY is included in the request's FindClosestBuildingInsightsRequest.additional_insights parameter. The GeoJSON data must be in RFC 7946 format and represent a Polygon for a single contiguous area. The Polygon will be represented by several loops when it contains holes. Example: { "type": "Polygon", "coordinates": [ [ [-1, -1, 0], [-1, 0, 0], [0, 0, 0], [-1, -1, 0] ] ] } + "a_key": "", # Properties of the object. + }, "stats": { # Size and sunniness quantiles of a roof, or part of a roof. # Total size and sunlight quantiles for the roof segment. "areaMeters2": 3.14, # The area of the roof or roof segment, in m^2. This is the roof area (accounting for tilt), not the ground footprint area. "groundAreaMeters2": 3.14, # The ground footprint area covered by the roof or roof segment, in m^2. diff --git a/docs/dyn/solar_v1.dataLayers.html b/docs/dyn/solar_v1.dataLayers.html index db6559180b..f4140d92ad 100644 --- a/docs/dyn/solar_v1.dataLayers.html +++ b/docs/dyn/solar_v1.dataLayers.html @@ -96,6 +96,7 @@

Method Details

Allowed values EXPERIMENT_UNSPECIFIED - No experiments are specified. EXPANDED_COVERAGE - Expands the geographic region available for querying solar data. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage). + ROOF_GEOMETRY_INSIGHTS - Enables experimental roof geometry data via FindClosestBuildingInsights. Requires `ROOF_GEOMETRY` to be included in the `additional_insights` field. Returns an error if passed to GetDataLayers. location_latitude: number, The latitude in degrees. It must be in the range [-90.0, +90.0]. location_longitude: number, The longitude in degrees. It must be in the range [-180.0, +180.0]. pixelSizeMeters: number, Optional. The minimum scale, in meters per pixel, of the data to return. Values of 0.1 (the default, if this field is not set explicitly), 0.25, 0.5, and 1.0 are supported. Imagery components whose normal resolution is less than `pixel_size_meters` will be returned at the resolution specified by `pixel_size_meters`; imagery components whose normal resolution is equal to or greater than `pixel_size_meters` will be returned at that normal resolution. diff --git a/googleapiclient/discovery_cache/documents/solar.v1.json b/googleapiclient/discovery_cache/documents/solar.v1.json index 5ccf3df2e7..9fb9349c9d 100644 --- a/googleapiclient/discovery_cache/documents/solar.v1.json +++ b/googleapiclient/discovery_cache/documents/solar.v1.json @@ -118,10 +118,12 @@ "description": "Optional. A list of additional_insights to be included in the response.", "enum": [ "ADDITIONAL_INSIGHTS_UNSPECIFIED", +"ROOF_GEOMETRY", "DETECTED_ARRAYS" ], "enumDescriptions": [ "The default value. The default BuildingInsights will be returned.", +"Determines whether to include the roof segment polygons and obstacles in the response. If specified, the response will contain a polygon_geojson field in each RoofSegmentSizeAndSunshineStats and the obstacles field in SolarPotential.", "Determines whether the response will include the detected arrays. If specified, the `detected_arrays` field will be populated in the response." ], "location": "query", @@ -137,11 +139,13 @@ "description": "Optional. Specifies the pre-GA experiments to enable. Requests using this field are classified as a pre-GA offering under the [Google Maps Platform Service Specific Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). See [launch stage descriptions](https://cloud.google.com/maps-platform/terms/launch-stages) for more details.", "enum": [ "EXPERIMENT_UNSPECIFIED", -"EXPANDED_COVERAGE" +"EXPANDED_COVERAGE", +"ROOF_GEOMETRY_INSIGHTS" ], "enumDescriptions": [ "No experiments are specified.", -"Expands the geographic region available for querying solar data. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage)." +"Expands the geographic region available for querying solar data. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage).", +"Enables experimental roof geometry data via FindClosestBuildingInsights. Requires `ROOF_GEOMETRY` to be included in the `additional_insights` field. Returns an error if passed to GetDataLayers." ], "location": "query", "repeated": true, @@ -207,11 +211,13 @@ "description": "Optional. Specifies the pre-GA experiments to enable. Requests using this field are classified as a pre-GA offering under the [Google Maps Platform Service Specific Terms](https://cloud.google.com/maps-platform/terms/maps-service-terms). See [launch stage descriptions]( https://cloud.google.com/maps-platform/terms/launch-stages) for more details.", "enum": [ "EXPERIMENT_UNSPECIFIED", -"EXPANDED_COVERAGE" +"EXPANDED_COVERAGE", +"ROOF_GEOMETRY_INSIGHTS" ], "enumDescriptions": [ "No experiments are specified.", -"Expands the geographic region available for querying solar data. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage)." +"Expands the geographic region available for querying solar data. For more information, see [Expanded Coverage](https://developers.google.com/maps/documentation/solar/expanded-coverage).", +"Enables experimental roof geometry data via FindClosestBuildingInsights. Requires `ROOF_GEOMETRY` to be included in the `additional_insights` field. Returns an error if passed to GetDataLayers." ], "location": "query", "repeated": true, @@ -318,7 +324,7 @@ } } }, -"revision": "20260506", +"revision": "20261001", "rootUrl": "https://solar.googleapis.com/", "schemas": { "BuildingInsights": { @@ -745,6 +751,22 @@ }, "type": "object" }, +"Obstacle": { +"description": "Details of a single detected obstacle.", +"id": "Obstacle", +"properties": { +"polygonGeojson": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. A GeoJSON representation of the obstacle. An obstacle is defined as any non-buildable area where solar panels cannot be placed due to physical barriers (vents, chimneys, dormers, etc.). The GeoJSON data must be in RFC 7946 format and represent a Polygon for a single contiguous area. The Polygon will be represented by several loops when it contains holes. Example: { \"type\": \"Polygon\", \"coordinates\": [ [ [-1, -1, 0], [-1, 0, 0], [0, 0, 0], [-1, -1, 0] ] ] }", +"readOnly": true, +"type": "object" +} +}, +"type": "object" +}, "RoofSegmentSizeAndSunshineStats": { "description": "Information about the size and sunniness quantiles of a roof segment.", "id": "RoofSegmentSizeAndSunshineStats", @@ -772,6 +794,15 @@ "format": "float", "type": "number" }, +"polygonGeojson": { +"additionalProperties": { +"description": "Properties of the object.", +"type": "any" +}, +"description": "Output only. A GeoJSON representation of the detailed geometry for the roof segment plane. The polygon represents the physical roof facet, excluding overlapping vegetation and internal cutouts (e.g., courtyards). This field is only populated if ROOF_GEOMETRY is included in the request's FindClosestBuildingInsightsRequest.additional_insights parameter. The GeoJSON data must be in RFC 7946 format and represent a Polygon for a single contiguous area. The Polygon will be represented by several loops when it contains holes. Example: { \"type\": \"Polygon\", \"coordinates\": [ [ [-1, -1, 0], [-1, 0, 0], [0, 0, 0], [-1, -1, 0] ] ] }", +"readOnly": true, +"type": "object" +}, "stats": { "$ref": "SizeAndSunshineStats", "description": "Total size and sunlight quantiles for the roof segment." @@ -961,6 +992,13 @@ "format": "float", "type": "number" }, +"obstacles": { +"description": "Details for each obstacle detected on the rooftop. An obstacle is defined as any non-buildable area where solar panels cannot be placed due to physical barriers (vents, chimneys, etc.). This field is only populated if ROOF_GEOMETRY is included in the request's FindClosestBuildingInsightsRequest.additional_insights.", +"items": { +"$ref": "Obstacle" +}, +"type": "array" +}, "panelCapacityWatts": { "description": "Capacity, in watts, of the panel used in the calculations.", "format": "float", From 448d9c8d0daa86e7d3ac57ad59fa279788866d98 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:39 +0000 Subject: [PATCH 36/41] feat(storage): update the api #### storage:v1 The following keys were added: - resources.objects.methods.viewFullContext (Total Keys: 20) - schemas.Bucket.properties.softDeletePolicy.properties.hardDeletePause (Total Keys: 4) - schemas.ObjectFullContext (Total Keys: 13) --- docs/dyn/storage_v1.buckets.html | 40 ++++++ docs/dyn/storage_v1.objects.html | 30 +++++ .../discovery_cache/documents/storage.v1.json | 118 +++++++++++++++++- 3 files changed, 186 insertions(+), 2 deletions(-) diff --git a/docs/dyn/storage_v1.buckets.html b/docs/dyn/storage_v1.buckets.html index 1961cab100..6d614348fc 100644 --- a/docs/dyn/storage_v1.buckets.html +++ b/docs/dyn/storage_v1.buckets.html @@ -360,6 +360,10 @@

Method Details

"selfLink": "A String", # The URI of this bucket. "softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted. "effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. + "hardDeletePause": { # The bucket's hard delete pause configuration. If set, soft-deleted objects in the bucket will not be permanently deleted until the hard delete pause is disabled. + "effectiveTime": "A String", # Server-determined value that indicates the time from which the hard delete pause became effective. This value is in RFC 3339 format. + "enabled": True or False, # Whether hard deletions are paused. + }, "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. @@ -669,6 +673,10 @@

Method Details

"selfLink": "A String", # The URI of this bucket. "softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted. "effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. + "hardDeletePause": { # The bucket's hard delete pause configuration. If set, soft-deleted objects in the bucket will not be permanently deleted until the hard delete pause is disabled. + "effectiveTime": "A String", # Server-determined value that indicates the time from which the hard delete pause became effective. This value is in RFC 3339 format. + "enabled": True or False, # Whether hard deletions are paused. + }, "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. @@ -913,6 +921,10 @@

Method Details

"selfLink": "A String", # The URI of this bucket. "softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted. "effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. + "hardDeletePause": { # The bucket's hard delete pause configuration. If set, soft-deleted objects in the bucket will not be permanently deleted until the hard delete pause is disabled. + "effectiveTime": "A String", # Server-determined value that indicates the time from which the hard delete pause became effective. This value is in RFC 3339 format. + "enabled": True or False, # Whether hard deletions are paused. + }, "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. @@ -1155,6 +1167,10 @@

Method Details

"selfLink": "A String", # The URI of this bucket. "softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted. "effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. + "hardDeletePause": { # The bucket's hard delete pause configuration. If set, soft-deleted objects in the bucket will not be permanently deleted until the hard delete pause is disabled. + "effectiveTime": "A String", # Server-determined value that indicates the time from which the hard delete pause became effective. This value is in RFC 3339 format. + "enabled": True or False, # Whether hard deletions are paused. + }, "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. @@ -1408,6 +1424,10 @@

Method Details

"selfLink": "A String", # The URI of this bucket. "softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted. "effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. + "hardDeletePause": { # The bucket's hard delete pause configuration. If set, soft-deleted objects in the bucket will not be permanently deleted until the hard delete pause is disabled. + "effectiveTime": "A String", # Server-determined value that indicates the time from which the hard delete pause became effective. This value is in RFC 3339 format. + "enabled": True or False, # Whether hard deletions are paused. + }, "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. @@ -1637,6 +1657,10 @@

Method Details

"selfLink": "A String", # The URI of this bucket. "softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted. "effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. + "hardDeletePause": { # The bucket's hard delete pause configuration. If set, soft-deleted objects in the bucket will not be permanently deleted until the hard delete pause is disabled. + "effectiveTime": "A String", # Server-determined value that indicates the time from which the hard delete pause became effective. This value is in RFC 3339 format. + "enabled": True or False, # Whether hard deletions are paused. + }, "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. @@ -1882,6 +1906,10 @@

Method Details

"selfLink": "A String", # The URI of this bucket. "softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted. "effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. + "hardDeletePause": { # The bucket's hard delete pause configuration. If set, soft-deleted objects in the bucket will not be permanently deleted until the hard delete pause is disabled. + "effectiveTime": "A String", # Server-determined value that indicates the time from which the hard delete pause became effective. This value is in RFC 3339 format. + "enabled": True or False, # Whether hard deletions are paused. + }, "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. @@ -2165,6 +2193,10 @@

Method Details

"selfLink": "A String", # The URI of this bucket. "softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted. "effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. + "hardDeletePause": { # The bucket's hard delete pause configuration. If set, soft-deleted objects in the bucket will not be permanently deleted until the hard delete pause is disabled. + "effectiveTime": "A String", # Server-determined value that indicates the time from which the hard delete pause became effective. This value is in RFC 3339 format. + "enabled": True or False, # Whether hard deletions are paused. + }, "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. @@ -2529,6 +2561,10 @@

Method Details

"selfLink": "A String", # The URI of this bucket. "softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted. "effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. + "hardDeletePause": { # The bucket's hard delete pause configuration. If set, soft-deleted objects in the bucket will not be permanently deleted until the hard delete pause is disabled. + "effectiveTime": "A String", # Server-determined value that indicates the time from which the hard delete pause became effective. This value is in RFC 3339 format. + "enabled": True or False, # Whether hard deletions are paused. + }, "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. @@ -2774,6 +2810,10 @@

Method Details

"selfLink": "A String", # The URI of this bucket. "softDeletePolicy": { # The bucket's soft delete policy, which defines the period of time that soft-deleted objects will be retained, and cannot be permanently deleted. "effectiveTime": "A String", # Server-determined value that indicates the time from which the policy, or one with a greater retention, was effective. This value is in RFC 3339 format. + "hardDeletePause": { # The bucket's hard delete pause configuration. If set, soft-deleted objects in the bucket will not be permanently deleted until the hard delete pause is disabled. + "effectiveTime": "A String", # Server-determined value that indicates the time from which the hard delete pause became effective. This value is in RFC 3339 format. + "enabled": True or False, # Whether hard deletions are paused. + }, "retentionDurationSeconds": "A String", # The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted. }, "softDeleteTime": "A String", # The soft delete time of the bucket in RFC 3339 format. diff --git a/docs/dyn/storage_v1.objects.html b/docs/dyn/storage_v1.objects.html index 34b7f505fb..caad6b4376 100644 --- a/docs/dyn/storage_v1.objects.html +++ b/docs/dyn/storage_v1.objects.html @@ -128,6 +128,9 @@

Instance Methods

update(bucket, object, body=None, generation=None, ifGenerationMatch=None, ifGenerationNotMatch=None, ifMetagenerationMatch=None, ifMetagenerationNotMatch=None, overrideUnlockedRetention=None, predefinedAcl=None, projection=None, userProject=None)

Updates an object's metadata.

+

+ viewFullContext(bucket, object, contextKey, generation=None, userProject=None)

+

Retrieves a specific object context with its extended data for a given object.

Method Details

bulkRestore(bucket, body=None) @@ -2239,4 +2242,31 @@

Method Details

}
+
+ viewFullContext(bucket, object, contextKey, generation=None, userProject=None) +
Retrieves a specific object context with its extended data for a given object.
+
+Args:
+  bucket: string, Name of the bucket in which the object resides. (required)
+  object: string, Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding). (required)
+  contextKey: string, Key identifying the object context to retrieve. (required)
+  generation: string, If present, selects a specific revision of this object (as opposed to the latest version, the default).
+  userProject: string, The project to be billed for this request. Required for Requester Pays buckets.
+
+Returns:
+  An object of the form:
+
+    { # A full representation of an object context.
+  "createTime": "A String", # The time at which the object context was created. This value is in RFC 3339 format.
+  "extendedData": { # The extended data of the object context.
+    "a_key": "", # Properties of the object. Contains field @type with type URL.
+  },
+  "key": "A String", # The key of the object context.
+  "kind": "storage#objectFullContext", # The kind of item this is. For ObjectFullContext, this is always storage#objectFullContext.
+  "type": "A String", # The type of the object context.
+  "updateTime": "A String", # The time at which the object context was last updated. This value is in RFC 3339 format.
+  "value": "A String", # The value of the object context.
+}
+
+ \ No newline at end of file diff --git a/googleapiclient/discovery_cache/documents/storage.v1.json b/googleapiclient/discovery_cache/documents/storage.v1.json index eb84b93567..1ddf5eefbe 100644 --- a/googleapiclient/discovery_cache/documents/storage.v1.json +++ b/googleapiclient/discovery_cache/documents/storage.v1.json @@ -253,7 +253,7 @@ "location": "northamerica-south1" } ], -"etag": "\"35383135343338383530313436313234313131\"", +"etag": "\"33373434373338383138373230333838393632\"", "icons": { "x16": "https://www.google.com/images/icons/product/cloud_storage-16.png", "x32": "https://www.google.com/images/icons/product/cloud_storage-32.png" @@ -4167,6 +4167,57 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/devstorage.full_control" ] +}, +"viewFullContext": { +"description": "Retrieves a specific object context with its extended data for a given object.", +"httpMethod": "GET", +"id": "storage.objects.viewFullContext", +"parameterOrder": [ +"bucket", +"object" +], +"parameters": { +"bucket": { +"description": "Name of the bucket in which the object resides.", +"location": "path", +"required": true, +"type": "string" +}, +"contextKey": { +"description": "Key identifying the object context to retrieve.", +"location": "query", +"required": true, +"type": "string" +}, +"generation": { +"description": "If present, selects a specific revision of this object (as opposed to the latest version, the default).", +"format": "int64", +"location": "query", +"type": "string" +}, +"object": { +"description": "Name of the object. For information about how to URL encode object names to be path safe, see [Encoding URI Path Parts](https://cloud.google.com/storage/docs/request-endpoints#encoding).", +"location": "path", +"required": true, +"type": "string" +}, +"userProject": { +"description": "The project to be billed for this request. Required for Requester Pays buckets.", +"location": "query", +"type": "string" +} +}, +"path": "b/{bucket}/o/{object}/viewFullContext", +"response": { +"$ref": "ObjectFullContext" +}, +"scopes": [ +"https://www.googleapis.com/auth/cloud-platform", +"https://www.googleapis.com/auth/cloud-platform.read-only", +"https://www.googleapis.com/auth/devstorage.full_control", +"https://www.googleapis.com/auth/devstorage.read_only", +"https://www.googleapis.com/auth/devstorage.read_write" +] } } }, @@ -4731,7 +4782,7 @@ } } }, -"revision": "20260911", +"revision": "20260930", "rootUrl": "https://storage.googleapis.com/", "schemas": { "AdvanceRelocateBucketOperationRequest": { @@ -5375,6 +5426,21 @@ "format": "date-time", "type": "string" }, +"hardDeletePause": { +"description": "The bucket's hard delete pause configuration. If set, soft-deleted objects in the bucket will not be permanently deleted until the hard delete pause is disabled.", +"properties": { +"effectiveTime": { +"description": "Server-determined value that indicates the time from which the hard delete pause became effective. This value is in RFC 3339 format.", +"format": "date-time", +"type": "string" +}, +"enabled": { +"description": "Whether hard deletions are paused.", +"type": "boolean" +} +}, +"type": "object" +}, "retentionDurationSeconds": { "description": "The duration in seconds that soft-deleted objects in the bucket will be retained and cannot be permanently deleted.", "format": "int64", @@ -6540,6 +6606,54 @@ }, "type": "object" }, +"ObjectFullContext": { +"description": "A full representation of an object context.", +"id": "ObjectFullContext", +"properties": { +"createTime": { +"description": "The time at which the object context was created. This value is in RFC 3339 format.", +"format": "date-time", +"type": "string" +}, +"extendedData": { +"additionalProperties": { +"description": "Properties of the object. Contains field @type with type URL.", +"type": "any" +}, +"description": "The extended data of the object context.", +"type": "object" +}, +"key": { +"description": "The key of the object context.", +"type": "string" +}, +"kind": { +"default": "storage#objectFullContext", +"description": "The kind of item this is. For ObjectFullContext, this is always storage#objectFullContext.", +"type": "string" +}, +"type": { +"description": "The type of the object context.", +"enum": [ +"CUSTOM" +], +"enumDescriptions": [ +"Custom object context." +], +"type": "string" +}, +"updateTime": { +"description": "The time at which the object context was last updated. This value is in RFC 3339 format.", +"format": "date-time", +"type": "string" +}, +"value": { +"description": "The value of the object context.", +"type": "string" +} +}, +"type": "object" +}, "Objects": { "description": "A list of objects.", "id": "Objects", From df8b9795bb7b5cb03a17e41cfac44d7dab8610d5 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:39 +0000 Subject: [PATCH 37/41] feat(storagebatchoperations): update the api #### storagebatchoperations:v1 The following keys were added: - schemas.ReconciliationOperationMetadata (Total Keys: 5) --- .../documents/storagebatchoperations.v1.json | 33 ++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json index a434bb8060..4bf22acd8f 100644 --- a/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json +++ b/googleapiclient/discovery_cache/documents/storagebatchoperations.v1.json @@ -569,7 +569,7 @@ } } }, -"revision": "20260601", +"revision": "20260923", "rootUrl": "https://storagebatchoperations.googleapis.com/", "schemas": { "AccessControlsUpdates": { @@ -1491,6 +1491,37 @@ }, "type": "object" }, +"ReconciliationOperationMetadata": { +"description": "Operation metadata returned by the CLH during resource state reconciliation.", +"id": "ReconciliationOperationMetadata", +"properties": { +"deleteResource": { +"deprecated": true, +"description": "DEPRECATED. Use exclusive_action instead.", +"type": "boolean" +}, +"exclusiveAction": { +"description": "Excluisive action returned by the CLH.", +"enum": [ +"UNKNOWN_REPAIR_ACTION", +"DELETE", +"RETRY" +], +"enumDeprecated": [ +false, +true, +false +], +"enumDescriptions": [ +"Unknown repair action.", +"The resource has to be deleted. When using this bit, the CLH should fail the operation. DEPRECATED. Instead use DELETE_RESOURCE OperationSignal in SideChannel.", +"This resource could not be repaired but the repair should be tried again at a later time. This can happen if there is a dependency that needs to be resolved first- e.g. if a parent resource must be repaired before a child resource." +], +"type": "string" +} +}, +"type": "object" +}, "RewriteObject": { "description": "Describes options for object rewrite.", "id": "RewriteObject", From ed5b6dbc5b40148cf85d07057783165ebf8e140f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:39 +0000 Subject: [PATCH 38/41] feat(threatintelligence): update the api #### threatintelligence:v1beta The following keys were added: - schemas.Alert.properties.tags (Total Keys: 3) --- ...atintelligence_v1beta.projects.alerts.html | 33 ++++++++++++++++++ .../documents/threatintelligence.v1beta.json | 34 ++++++++++++++++++- 2 files changed, 66 insertions(+), 1 deletion(-) diff --git a/docs/dyn/threatintelligence_v1beta.projects.alerts.html b/docs/dyn/threatintelligence_v1beta.projects.alerts.html index 4f4bff9e6b..d344e1b018 100644 --- a/docs/dyn/threatintelligence_v1beta.projects.alerts.html +++ b/docs/dyn/threatintelligence_v1beta.projects.alerts.html @@ -386,6 +386,9 @@

Method Details

"severityLevel": "A String", # The level of severity. }, "state": "A String", # Output only. State of the alert. + "tags": [ # Output only. System taxonomy tags associated with this alert. + "A String", + ], } @@ -656,6 +659,9 @@

Method Details

"severityLevel": "A String", # The level of severity. }, "state": "A String", # Output only. State of the alert. + "tags": [ # Output only. System taxonomy tags associated with this alert. + "A String", + ], } @@ -954,6 +960,9 @@

Method Details

"severityLevel": "A String", # The level of severity. }, "state": "A String", # Output only. State of the alert. + "tags": [ # Output only. System taxonomy tags associated with this alert. + "A String", + ], } @@ -1218,6 +1227,9 @@

Method Details

"severityLevel": "A String", # The level of severity. }, "state": "A String", # Output only. State of the alert. + "tags": [ # Output only. System taxonomy tags associated with this alert. + "A String", + ], } @@ -1476,6 +1488,9 @@

Method Details

"severityLevel": "A String", # The level of severity. }, "state": "A String", # Output only. State of the alert. + "tags": [ # Output only. System taxonomy tags associated with this alert. + "A String", + ], } @@ -1759,6 +1774,9 @@

Method Details

"severityLevel": "A String", # The level of severity. }, "state": "A String", # Output only. State of the alert. + "tags": [ # Output only. System taxonomy tags associated with this alert. + "A String", + ], }, ], "nextPageToken": "A String", # Page token. @@ -2040,6 +2058,9 @@

Method Details

"severityLevel": "A String", # The level of severity. }, "state": "A String", # Output only. State of the alert. + "tags": [ # Output only. System taxonomy tags associated with this alert. + "A String", + ], } @@ -2304,6 +2325,9 @@

Method Details

"severityLevel": "A String", # The level of severity. }, "state": "A String", # Output only. State of the alert. + "tags": [ # Output only. System taxonomy tags associated with this alert. + "A String", + ], } @@ -2568,6 +2592,9 @@

Method Details

"severityLevel": "A String", # The level of severity. }, "state": "A String", # Output only. State of the alert. + "tags": [ # Output only. System taxonomy tags associated with this alert. + "A String", + ], } @@ -2832,6 +2859,9 @@

Method Details

"severityLevel": "A String", # The level of severity. }, "state": "A String", # Output only. State of the alert. + "tags": [ # Output only. System taxonomy tags associated with this alert. + "A String", + ], } @@ -3096,6 +3126,9 @@

Method Details

"severityLevel": "A String", # The level of severity. }, "state": "A String", # Output only. State of the alert. + "tags": [ # Output only. System taxonomy tags associated with this alert. + "A String", + ], } diff --git a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json index 1707395d50..03f63925a2 100644 --- a/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json +++ b/googleapiclient/discovery_cache/documents/threatintelligence.v1beta.json @@ -842,7 +842,7 @@ } } }, -"revision": "20260924", +"revision": "20260927", "rootUrl": "https://threatintelligence.googleapis.com/", "schemas": { "AVDetections": { @@ -978,6 +978,38 @@ ], "readOnly": true, "type": "string" +}, +"tags": { +"description": "Output only. System taxonomy tags associated with this alert.", +"items": { +"enum": [ +"ALERT_TAG_UNSPECIFIED", +"ALERT_TAG_PASSWORD_LENGTH_UNDER_8", +"ALERT_TAG_PASSWORD_LENGTH_8_TO_11", +"ALERT_TAG_PASSWORD_LENGTH_12_PLUS", +"ALERT_TAG_PASSWORD_HAS_LOWERCASE", +"ALERT_TAG_PASSWORD_HAS_UPPERCASE", +"ALERT_TAG_PASSWORD_HAS_NUMBER", +"ALERT_TAG_PASSWORD_HAS_SPECIAL", +"ALERT_TAG_MATCH_LOGIN_EMAIL_DOMAIN", +"ALERT_TAG_MATCH_SERVICE_DOMAIN" +], +"enumDescriptions": [ +"Default value, should never be set.", +"Password length is under 8 characters.", +"Password length is between 8 and 11 characters inclusive.", +"Password length is 12 or more characters.", +"Password contains at least one lowercase letter.", +"Password contains at least one uppercase letter.", +"Password contains at least one numeric digit.", +"Password contains at least one special character.", +"Credential login email domain matches a customer domain.", +"Credential service domain matches a customer domain." +], +"type": "string" +}, +"readOnly": true, +"type": "array" } }, "type": "object" From 9d7fca7f8120956855a632fd4f886957698d3ab2 Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:40 +0000 Subject: [PATCH 39/41] feat(tpu): update the api #### tpu:v2 The following keys were added: - schemas.Node.properties.protectionTier (Total Keys: 2) --- docs/dyn/tpu_v1.projects.locations.html | 6 +++--- docs/dyn/tpu_v1alpha1.projects.locations.html | 6 +++--- docs/dyn/tpu_v2.projects.locations.html | 6 +++--- docs/dyn/tpu_v2.projects.locations.nodes.html | 4 ++++ ...v2.projects.locations.queuedResources.html | 3 +++ docs/dyn/tpu_v2alpha1.projects.locations.html | 6 +++--- .../discovery_cache/documents/tpu.v1.json | 6 +++--- .../documents/tpu.v1alpha1.json | 6 +++--- .../discovery_cache/documents/tpu.v2.json | 21 ++++++++++++++++--- .../documents/tpu.v2alpha1.json | 6 +++--- 10 files changed, 46 insertions(+), 24 deletions(-) diff --git a/docs/dyn/tpu_v1.projects.locations.html b/docs/dyn/tpu_v1.projects.locations.html index 920e016fe7..851c517256 100644 --- a/docs/dyn/tpu_v1.projects.locations.html +++ b/docs/dyn/tpu_v1.projects.locations.html @@ -102,7 +102,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -141,11 +141,11 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/tpu_v1alpha1.projects.locations.html b/docs/dyn/tpu_v1alpha1.projects.locations.html
index c1b6d5216e..67510929b8 100644
--- a/docs/dyn/tpu_v1alpha1.projects.locations.html
+++ b/docs/dyn/tpu_v1alpha1.projects.locations.html
@@ -102,7 +102,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -141,11 +141,11 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/tpu_v2.projects.locations.html b/docs/dyn/tpu_v2.projects.locations.html
index c30835f5eb..bbde0332e3 100644
--- a/docs/dyn/tpu_v2.projects.locations.html
+++ b/docs/dyn/tpu_v2.projects.locations.html
@@ -110,7 +110,7 @@ 

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -176,11 +176,11 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/docs/dyn/tpu_v2.projects.locations.nodes.html b/docs/dyn/tpu_v2.projects.locations.nodes.html
index 008985fdd6..06cc310456 100644
--- a/docs/dyn/tpu_v2.projects.locations.nodes.html
+++ b/docs/dyn/tpu_v2.projects.locations.nodes.html
@@ -176,6 +176,7 @@ 

Method Details

"port": 42, # The port of this network endpoint. }, ], + "protectionTier": "A String", # Output only. Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures). "queuedResource": "A String", # Output only. The qualified name of the QueuedResource that requested this Node. "runtimeVersion": "A String", # Required. The runtime version running in the Node. "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node. @@ -350,6 +351,7 @@

Method Details

"port": 42, # The port of this network endpoint. }, ], + "protectionTier": "A String", # Output only. Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures). "queuedResource": "A String", # Output only. The qualified name of the QueuedResource that requested this Node. "runtimeVersion": "A String", # Required. The runtime version running in the Node. "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node. @@ -507,6 +509,7 @@

Method Details

"port": 42, # The port of this network endpoint. }, ], + "protectionTier": "A String", # Output only. Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures). "queuedResource": "A String", # Output only. The qualified name of the QueuedResource that requested this Node. "runtimeVersion": "A String", # Required. The runtime version running in the Node. "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node. @@ -631,6 +634,7 @@

Method Details

"port": 42, # The port of this network endpoint. }, ], + "protectionTier": "A String", # Output only. Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures). "queuedResource": "A String", # Output only. The qualified name of the QueuedResource that requested this Node. "runtimeVersion": "A String", # Required. The runtime version running in the Node. "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node. diff --git a/docs/dyn/tpu_v2.projects.locations.queuedResources.html b/docs/dyn/tpu_v2.projects.locations.queuedResources.html index 24b82b6b51..a7fbd0cf41 100644 --- a/docs/dyn/tpu_v2.projects.locations.queuedResources.html +++ b/docs/dyn/tpu_v2.projects.locations.queuedResources.html @@ -222,6 +222,7 @@

Method Details

"port": 42, # The port of this network endpoint. }, ], + "protectionTier": "A String", # Output only. Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures). "queuedResource": "A String", # Output only. The qualified name of the QueuedResource that requested this Node. "runtimeVersion": "A String", # Required. The runtime version running in the Node. "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node. @@ -460,6 +461,7 @@

Method Details

"port": 42, # The port of this network endpoint. }, ], + "protectionTier": "A String", # Output only. Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures). "queuedResource": "A String", # Output only. The qualified name of the QueuedResource that requested this Node. "runtimeVersion": "A String", # Required. The runtime version running in the Node. "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node. @@ -636,6 +638,7 @@

Method Details

"port": 42, # The port of this network endpoint. }, ], + "protectionTier": "A String", # Output only. Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures). "queuedResource": "A String", # Output only. The qualified name of the QueuedResource that requested this Node. "runtimeVersion": "A String", # Required. The runtime version running in the Node. "schedulingConfig": { # Sets the scheduling options for this node. # The scheduling options for this node. diff --git a/docs/dyn/tpu_v2alpha1.projects.locations.html b/docs/dyn/tpu_v2alpha1.projects.locations.html index f5e597c21d..46ee0dbe0e 100644 --- a/docs/dyn/tpu_v2alpha1.projects.locations.html +++ b/docs/dyn/tpu_v2alpha1.projects.locations.html @@ -115,7 +115,7 @@

Instance Methods

Gets information about a location.

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None)

-

Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.

+

Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.

list_next(previous_request, previous_response)

Retrieves the next page of results.

@@ -181,11 +181,11 @@

Method Details

list(name, extraLocationTypes=None, filter=None, pageSize=None, pageToken=None, x__xgafv=None) -
Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.
+  
Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.
 
 Args:
   name: string, The resource that owns the locations collection, if applicable. (required)
-  extraLocationTypes: string, Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
+  extraLocationTypes: string, Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage. (repeated)
   filter: string, A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).
   pageSize: integer, The maximum number of results to return. If not set, the service selects a default.
   pageToken: string, A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.
diff --git a/googleapiclient/discovery_cache/documents/tpu.v1.json b/googleapiclient/discovery_cache/documents/tpu.v1.json
index 9f86f31257..9beec472f0 100644
--- a/googleapiclient/discovery_cache/documents/tpu.v1.json
+++ b/googleapiclient/discovery_cache/documents/tpu.v1.json
@@ -135,7 +135,7 @@
 ]
 },
 "list": {
-"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
+"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.",
 "flatPath": "v1/projects/{projectsId}/locations",
 "httpMethod": "GET",
 "id": "tpu.projects.locations.list",
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -684,7 +684,7 @@
 }
 }
 },
-"revision": "20260127",
+"revision": "20261001",
 "rootUrl": "https://tpu.googleapis.com/",
 "schemas": {
 "AcceleratorType": {
diff --git a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json
index b852c111e4..32dccc9763 100644
--- a/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json
+++ b/googleapiclient/discovery_cache/documents/tpu.v1alpha1.json
@@ -135,7 +135,7 @@
 ]
 },
 "list": {
-"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
+"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.",
 "flatPath": "v1alpha1/projects/{projectsId}/locations",
 "httpMethod": "GET",
 "id": "tpu.projects.locations.list",
@@ -144,7 +144,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -694,7 +694,7 @@
 }
 }
 },
-"revision": "20260127",
+"revision": "20261001",
 "rootUrl": "https://tpu.googleapis.com/",
 "schemas": {
 "AcceleratorType": {
diff --git a/googleapiclient/discovery_cache/documents/tpu.v2.json b/googleapiclient/discovery_cache/documents/tpu.v2.json
index fe7bf9ab7a..0270fc9d07 100644
--- a/googleapiclient/discovery_cache/documents/tpu.v2.json
+++ b/googleapiclient/discovery_cache/documents/tpu.v2.json
@@ -163,7 +163,7 @@
 ]
 },
 "list": {
-"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
+"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.",
 "flatPath": "v2/projects/{projectsId}/locations",
 "httpMethod": "GET",
 "id": "tpu.projects.locations.list",
@@ -172,7 +172,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -898,7 +898,7 @@
 }
 }
 },
-"revision": "20260127",
+"revision": "20261001",
 "rootUrl": "https://tpu.googleapis.com/",
 "schemas": {
 "AcceleratorConfig": {
@@ -1552,6 +1552,21 @@
 "readOnly": true,
 "type": "array"
 },
+"protectionTier": {
+"description": "Output only. Protection tier for the workload which specifies the workload expectations in the event of infrastructure failures at data center (e.g. power and/or cooling failures).",
+"enum": [
+"PROTECTION_TIER_UNSPECIFIED",
+"STANDARD",
+"CAPACITY_OPTIMIZED"
+],
+"enumDescriptions": [
+"Protection tier is unknown.",
+"STANDARD protection for workload that should be protected by redundancies (e.g. power, cooling) at the data center level. In the event of infrastructure failures at data center (e.g. power and/or cooling failures), this workload is expected to continue as normal using the redundancies.",
+"CAPACITY_OPTIMIZED capacity leverages redundancies (e.g. power, cooling) at the data center during normal operating conditions. In the event of infrastructure failures at data center (e.g. power and/or cooling failures), this workload may be disrupted. As a consequence, it has a weaker availability SLO than STANDARD."
+],
+"readOnly": true,
+"type": "string"
+},
 "queuedResource": {
 "description": "Output only. The qualified name of the QueuedResource that requested this Node.",
 "readOnly": true,
diff --git a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json
index 75a9d858c3..dc1cc8b997 100644
--- a/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json
+++ b/googleapiclient/discovery_cache/documents/tpu.v2alpha1.json
@@ -163,7 +163,7 @@
 ]
 },
 "list": {
-"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
+"description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.",
 "flatPath": "v2alpha1/projects/{projectsId}/locations",
 "httpMethod": "GET",
 "id": "tpu.projects.locations.list",
@@ -172,7 +172,7 @@
 ],
 "parameters": {
 "extraLocationTypes": {
-"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
+"description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage.",
 "location": "query",
 "repeated": true,
 "type": "string"
@@ -1057,7 +1057,7 @@
 }
 }
 },
-"revision": "20260127",
+"revision": "20261001",
 "rootUrl": "https://tpu.googleapis.com/",
 "schemas": {
 "AcceleratorConfig": {

From ba0885d9833822cfc89d0a65fa6ebe6f34b37d66 Mon Sep 17 00:00:00 2001
From: Yoshi Automation 
Date: Tue, 6 Oct 2026 07:25:40 +0000
Subject: [PATCH 40/41] fix(workstations): update the api

#### workstations:v1

The following keys were changed:
- endpoints (Total Keys: 1)

#### workstations:v1beta

The following keys were changed:
- endpoints (Total Keys: 1)
---
 ...orkstationClusters.workstationConfigs.html | 10 +++----
 ...orkstationClusters.workstationConfigs.html | 30 +++++++++----------
 .../documents/workstations.v1.json            | 14 +++++++--
 .../documents/workstations.v1beta.json        | 18 ++++++++---
 4 files changed, 46 insertions(+), 26 deletions(-)

diff --git a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html
index 66bcbfffc2..2a9a7554c0 100644
--- a/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html
+++ b/docs/dyn/workstations_v1.projects.locations.workstationClusters.workstationConfigs.html
@@ -280,7 +280,7 @@ 

Method Details

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

Method Details

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

Method Details

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

Method Details

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

Method Details

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

Method Details

"gceHd": { # A Persistent Directory backed by a Compute Engine [Hyperdisk Balanced High Availability Disk](https://cloud.google.com/compute/docs/disks/hd-types/hyperdisk-balanced-ha). This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads. # A PersistentDirectory backed by a Compute Engine hyperdisk high availability disk. "archiveTimeout": "A String", # Optional. Number of seconds to wait after initially creating or subsequently shutting down the workstation before converting its disk into a snapshot. This generally saves costs at the expense of greater startup time on next workstation start, as the service will need to create a disk from the archival snapshot. A value of `"0s"` indicates that the disk will never be archived. "maxSizeGb": 42, # Optional. Maximum size in GB to which this persistent directory can be resized. Defaults to `0`, which indicates no maximum limit is enforced by this configuration. Resizing is still subject to the quotas and limits of the underlying disk type. - "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3000 and 100,000. - "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 2,400. + "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3,000 and 100,000. + "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. Values must be between 1 and 2,400. "reclaimPolicy": "A String", # Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`. "sizeGb": 42, # Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. "sourceSnapshot": "A String", # Optional. Name of the snapshot to use as the source for the disk. If set, size_gb must be empty. Must be formatted as ext4 file system with no partitions. @@ -301,7 +301,7 @@

Method Details

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

Method Details

"gceHd": { # A Persistent Directory backed by a Compute Engine [Hyperdisk Balanced High Availability Disk](https://cloud.google.com/compute/docs/disks/hd-types/hyperdisk-balanced-ha). This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads. # A PersistentDirectory backed by a Compute Engine hyperdisk high availability disk. "archiveTimeout": "A String", # Optional. Number of seconds to wait after initially creating or subsequently shutting down the workstation before converting its disk into a snapshot. This generally saves costs at the expense of greater startup time on next workstation start, as the service will need to create a disk from the archival snapshot. A value of `"0s"` indicates that the disk will never be archived. "maxSizeGb": 42, # Optional. Maximum size in GB to which this persistent directory can be resized. Defaults to `0`, which indicates no maximum limit is enforced by this configuration. Resizing is still subject to the quotas and limits of the underlying disk type. - "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3000 and 100,000. - "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 2,400. + "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3,000 and 100,000. + "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. Values must be between 1 and 2,400. "reclaimPolicy": "A String", # Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`. "sizeGb": 42, # Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. "sourceSnapshot": "A String", # Optional. Name of the snapshot to use as the source for the disk. If set, size_gb must be empty. Must be formatted as ext4 file system with no partitions. @@ -562,7 +562,7 @@

Method Details

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

Method Details

"gceHd": { # A Persistent Directory backed by a Compute Engine [Hyperdisk Balanced High Availability Disk](https://cloud.google.com/compute/docs/disks/hd-types/hyperdisk-balanced-ha). This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads. # A PersistentDirectory backed by a Compute Engine hyperdisk high availability disk. "archiveTimeout": "A String", # Optional. Number of seconds to wait after initially creating or subsequently shutting down the workstation before converting its disk into a snapshot. This generally saves costs at the expense of greater startup time on next workstation start, as the service will need to create a disk from the archival snapshot. A value of `"0s"` indicates that the disk will never be archived. "maxSizeGb": 42, # Optional. Maximum size in GB to which this persistent directory can be resized. Defaults to `0`, which indicates no maximum limit is enforced by this configuration. Resizing is still subject to the quotas and limits of the underlying disk type. - "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3000 and 100,000. - "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 2,400. + "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3,000 and 100,000. + "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. Values must be between 1 and 2,400. "reclaimPolicy": "A String", # Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`. "sizeGb": 42, # Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. "sourceSnapshot": "A String", # Optional. Name of the snapshot to use as the source for the disk. If set, size_gb must be empty. Must be formatted as ext4 file system with no partitions. @@ -812,7 +812,7 @@

Method Details

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

Method Details

"gceHd": { # A Persistent Directory backed by a Compute Engine [Hyperdisk Balanced High Availability Disk](https://cloud.google.com/compute/docs/disks/hd-types/hyperdisk-balanced-ha). This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads. # A PersistentDirectory backed by a Compute Engine hyperdisk high availability disk. "archiveTimeout": "A String", # Optional. Number of seconds to wait after initially creating or subsequently shutting down the workstation before converting its disk into a snapshot. This generally saves costs at the expense of greater startup time on next workstation start, as the service will need to create a disk from the archival snapshot. A value of `"0s"` indicates that the disk will never be archived. "maxSizeGb": 42, # Optional. Maximum size in GB to which this persistent directory can be resized. Defaults to `0`, which indicates no maximum limit is enforced by this configuration. Resizing is still subject to the quotas and limits of the underlying disk type. - "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3000 and 100,000. - "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 2,400. + "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3,000 and 100,000. + "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. Values must be between 1 and 2,400. "reclaimPolicy": "A String", # Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`. "sizeGb": 42, # Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. "sourceSnapshot": "A String", # Optional. Name of the snapshot to use as the source for the disk. If set, size_gb must be empty. Must be formatted as ext4 file system with no partitions. @@ -1015,7 +1015,7 @@

Method Details

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

Method Details

"gceHd": { # A Persistent Directory backed by a Compute Engine [Hyperdisk Balanced High Availability Disk](https://cloud.google.com/compute/docs/disks/hd-types/hyperdisk-balanced-ha). This is a high-availability block storage solution that offers a balance between performance and cost for most general-purpose workloads. # A PersistentDirectory backed by a Compute Engine hyperdisk high availability disk. "archiveTimeout": "A String", # Optional. Number of seconds to wait after initially creating or subsequently shutting down the workstation before converting its disk into a snapshot. This generally saves costs at the expense of greater startup time on next workstation start, as the service will need to create a disk from the archival snapshot. A value of `"0s"` indicates that the disk will never be archived. "maxSizeGb": 42, # Optional. Maximum size in GB to which this persistent directory can be resized. Defaults to `0`, which indicates no maximum limit is enforced by this configuration. Resizing is still subject to the quotas and limits of the underlying disk type. - "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3000 and 100,000. - "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 2,400. + "provisionedIops": "A String", # Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3,000 and 100,000. + "provisionedThroughput": "A String", # Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. Values must be between 1 and 2,400. "reclaimPolicy": "A String", # Optional. Whether the persistent disk should be deleted when the workstation is deleted. Valid values are `DELETE` and `RETAIN`. Defaults to `DELETE`. "sizeGb": 42, # Optional. The GB capacity of a persistent home directory for each workstation created with this configuration. Must be empty if source_snapshot is set. Valid values are `10`, `50`, `100`, `200`, `500`, or `1000`. Defaults to `200`. "sourceSnapshot": "A String", # Optional. Name of the snapshot to use as the source for the disk. If set, size_gb must be empty. Must be formatted as ext4 file system with no partitions. @@ -1233,7 +1233,7 @@

Method Details

"replicaZones": [ # Optional. Immutable. Specifies the zones used to replicate the VM and disk resources within the region. If set, exactly two zones within the workstation cluster's region must be specified—for example, `['us-central1-a', 'us-central1-f']`. If this field is empty, two default zones within the region are used. Immutable after the workstation configuration is created. "A String", ], - "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. + "runningTimeout": "A String", # Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: - STATE_RUNNING - STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds—for example, `"54000s"` (15 hours). Defaults to `"43200s"` (12 hours). A value of `"0s"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `"0s"` and less than `"86400s"` (24 hours). Warning: A value of `"0s"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates. "satisfiesPzi": True or False, # Output only. Reserved for future use. "satisfiesPzs": True or False, # Output only. Reserved for future use. "uid": "A String", # Output only. A system-assigned unique identifier for this workstation configuration. diff --git a/googleapiclient/discovery_cache/documents/workstations.v1.json b/googleapiclient/discovery_cache/documents/workstations.v1.json index 09ef55948a..3bb9f914b3 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1.json @@ -18,6 +18,16 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://workstations.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://workstations.us-central1.rep.googleapis.com/", "location": "us-central1" }, @@ -1281,7 +1291,7 @@ } } }, -"revision": "20260909", +"revision": "20260923", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -2747,7 +2757,7 @@ "type": "array" }, "runningTimeout": { -"description": "Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", +"description": "Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: - STATE_RUNNING - STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", "format": "google-duration", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/workstations.v1beta.json b/googleapiclient/discovery_cache/documents/workstations.v1beta.json index bd16165169..1ca0be5cb5 100644 --- a/googleapiclient/discovery_cache/documents/workstations.v1beta.json +++ b/googleapiclient/discovery_cache/documents/workstations.v1beta.json @@ -18,6 +18,16 @@ "endpoints": [ { "description": "Regional Endpoint", +"endpointUrl": "https://workstations.asia-south1.rep.googleapis.com/", +"location": "asia-south1" +}, +{ +"description": "Regional Endpoint", +"endpointUrl": "https://workstations.europe-west6.rep.googleapis.com/", +"location": "europe-west6" +}, +{ +"description": "Regional Endpoint", "endpointUrl": "https://workstations.us-central1.rep.googleapis.com/", "location": "us-central1" }, @@ -1235,7 +1245,7 @@ } } }, -"revision": "20260909", +"revision": "20260923", "rootUrl": "https://workstations.googleapis.com/", "schemas": { "Accelerator": { @@ -1512,12 +1522,12 @@ "type": "integer" }, "provisionedIops": { -"description": "Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3000 and 100,000.", +"description": "Optional. Indicates how many IOPS to provision for the disk. This sets the number of I/O operations per second that the disk can handle. Values must be between 3,000 and 100,000.", "format": "int64", "type": "string" }, "provisionedThroughput": { -"description": "Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput mb per second that the disk can handle. Values must be between 1 and 2,400.", +"description": "Optional. Indicates how much throughput to provision for the disk. This sets the number of throughput MB per second that the disk can handle. Values must be between 1 and 2,400.", "format": "int64", "type": "string" }, @@ -2826,7 +2836,7 @@ "type": "array" }, "runningTimeout": { -"description": "Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: * STATE_RUNNING * STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", +"description": "Optional. Number of seconds to wait before automatically stopping a workstation. We recommend that workstations be stopped daily so that security updates can be applied upon restart. The idle_timeout and running_timeout fields are independent of each other. Note that the running_timeout field stops workstations after the specified time, regardless of whether or not the workstations are idle. Note: This timeout applies to workstations in the following states: - STATE_RUNNING - STATE_SUSPENDED Suspending a workstation does not reset this timeout. Provide duration terminated by `s` for seconds\u2014for example, `\"54000s\"` (15 hours). Defaults to `\"43200s\"` (12 hours). A value of `\"0s\"` indicates that workstations using this configuration should never time out. If encryption_key is set, it must be greater than `\"0s\"` and less than `\"86400s\"` (24 hours). Warning: A value of `\"0s\"` indicates that Cloud Workstations VMs created with this configuration have no maximum running time. This is strongly discouraged because you incur costs and will not pick up security updates.", "format": "google-duration", "type": "string" }, From c714fc7745ec0b4dba3aeb7aeb46def438e1eb8f Mon Sep 17 00:00:00 2001 From: Yoshi Automation Date: Tue, 6 Oct 2026 07:25:40 +0000 Subject: [PATCH 41/41] chore(docs): Add new discovery artifacts and artifacts with minor updates --- ...ects.locations.dataExchanges.listings.html | 4 +-- docs/dyn/chat_v1.spaces.html | 26 +++++++------- docs/dyn/chat_v1.spaces.messages.html | 18 +++++----- docs/dyn/chat_v1.spaces.spaceEvents.html | 32 ++++++++--------- docs/dyn/cloudsupport_v2.cases.html | 36 +++++++++---------- docs/dyn/cloudsupport_v2beta.cases.html | 36 +++++++++---------- ...tainer_v1.projects.locations.clusters.html | 8 ++--- .../container_v1.projects.zones.clusters.html | 8 ++--- ...r_v1beta1.projects.locations.clusters.html | 8 ++--- ...ainer_v1beta1.projects.zones.clusters.html | 8 ++--- .../dyn/css_v1.accounts.cssProductInputs.html | 32 ++++++++--------- docs/dyn/css_v1.accounts.cssProducts.html | 16 ++++----- docs/dyn/databasecenter_v1beta.v1beta.html | 4 +-- ...n_v1alpha.projects.locations.sessions.html | 12 +++---- docs/dyn/fcm_v1.projects.messages.html | 4 +-- ...cts.databases.collectionGroups.fields.html | 6 ++-- ...ts.databases.collectionGroups.indexes.html | 6 ++-- ...hantapi_accounts_v1.accounts.programs.html | 8 ++--- ...api_accounts_v1beta.accounts.programs.html | 8 ++--- .../dyn/run_v1.namespaces.configurations.html | 8 ++--- docs/dyn/run_v1.namespaces.executions.html | 12 +++---- docs/dyn/run_v1.namespaces.instances.html | 32 ++++++++--------- docs/dyn/run_v1.namespaces.jobs.html | 28 +++++++-------- docs/dyn/run_v1.namespaces.revisions.html | 8 ++--- docs/dyn/run_v1.namespaces.services.html | 24 ++++++------- docs/dyn/run_v1.namespaces.tasks.html | 8 ++--- docs/dyn/run_v1.namespaces.workerpools.html | 24 ++++++------- ..._v1.projects.locations.configurations.html | 8 ++--- .../run_v1.projects.locations.revisions.html | 8 ++--- .../run_v1.projects.locations.services.html | 24 ++++++------- docs/dyn/sqladmin_v1.workloadCaptures.html | 4 +-- ....projects.locations.dnsBindPermission.html | 4 +-- .../vmwareengine_v1.projects.locations.html | 2 +- ...ects.locations.privateClouds.clusters.html | 16 ++++----- ...e_v1.projects.locations.privateClouds.html | 22 ++++++------ docs/dyn/youtube_v3.commentThreads.html | 6 ++++ docs/dyn/youtube_v3.comments.html | 5 +++ .../documents/analyticshub.v1.json | 8 ++--- .../discovery_cache/documents/chat.v1.json | 8 ++--- .../documents/chromemanagement.v1.json | 6 ++-- .../documents/cloudproductregistry.v1.json | 20 +++++++++-- .../documents/cloudsupport.v2.json | 6 ++-- .../documents/cloudsupport.v2beta.json | 6 ++-- .../documents/container.v1.json | 14 ++++---- .../documents/container.v1beta1.json | 14 ++++---- .../discovery_cache/documents/css.v1.json | 10 +++--- .../documents/databasecenter.v1beta.json | 6 ++-- .../documents/devicerun.v1alpha.json | 6 ++-- .../discovery_cache/documents/fcm.v1.json | 4 +-- .../documents/firestore.v1.json | 4 +-- .../documents/merchantapi.accounts_v1.json | 4 +-- .../merchantapi.accounts_v1beta.json | 4 +-- .../documents/merchantapi.products_v1.json | 14 +++++--- .../discovery_cache/documents/run.v1.json | 6 ++-- .../documents/sqladmin.v1.json | 6 ++-- .../documents/vmwareengine.v1.json | 16 ++++----- .../documents/workspaceevents.v1.json | 4 +-- .../discovery_cache/documents/youtube.v3.json | 7 +++- 58 files changed, 367 insertions(+), 329 deletions(-) diff --git a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html index 4836260b7c..3134cc019c 100644 --- a/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html +++ b/docs/dyn/analyticshub_v1.projects.locations.dataExchanges.listings.html @@ -936,7 +936,7 @@

Method Details

"A String", ], }, - "rowKeySchema": { # Row key definition that reads the input message fields based on the field names of the table's structured row key (https://docs.cloud.google.com/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. # Optional. If set, the row key is constructed from the field names of the table's structured row key (https://docs.cloud.google.com/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead. + "rowKeySchema": { # Row key definition that reads the input message fields based on the field names of the table's [structured row key](https://cloud.google.com/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; `null` will be used instead. # Optional. If set, the row key is constructed from the field names of the table's [structured row key](https://cloud.google.com/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; `null` will be used instead. }, }, "serviceAccountEmail": "A String", # Optional. The service account to use to write to Bigtable. The subscription creator or updater that specifies this field must have `iam.serviceAccounts.actAs` permission on the service account. If not specified, the Pub/Sub [service agent](https://cloud.google.com/iam/docs/service-agents), service-{project_number}@gcp-sa-pubsub.iam.gserviceaccount.com, is used. @@ -1018,7 +1018,7 @@

Method Details

"maximumBackoff": "A String", # Optional. The maximum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 600 seconds. "minimumBackoff": "A String", # Optional. The minimum delay between consecutive deliveries of a given message. Value should be between 0 and 600 seconds. Defaults to 10 seconds. }, - "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" See https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags for more information on using tags with Pub/Sub resources. + "tags": { # Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing" See [Create and manage tags](https://cloud.google.com/pubsub/docs/tags) for more information on using tags with Pub/Sub resources. "a_key": "A String", }, }, diff --git a/docs/dyn/chat_v1.spaces.html b/docs/dyn/chat_v1.spaces.html index 7a5ca0e520..6b3394c451 100644 --- a/docs/dyn/chat_v1.spaces.html +++ b/docs/dyn/chat_v1.spaces.html @@ -260,7 +260,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -378,7 +378,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -495,7 +495,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -637,7 +637,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -770,7 +770,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -910,7 +910,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -1038,7 +1038,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -1172,7 +1172,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -1290,7 +1290,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -1421,7 +1421,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -1531,7 +1531,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -1689,7 +1689,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -1806,7 +1806,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. diff --git a/docs/dyn/chat_v1.spaces.messages.html b/docs/dyn/chat_v1.spaces.messages.html index fe2a822324..3dbfc69082 100644 --- a/docs/dyn/chat_v1.spaces.messages.html +++ b/docs/dyn/chat_v1.spaces.messages.html @@ -3179,7 +3179,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -6268,7 +6268,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -9375,7 +9375,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -12470,7 +12470,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -15565,7 +15565,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -18643,7 +18643,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -21742,7 +21742,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -24839,7 +24839,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -27917,7 +27917,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. diff --git a/docs/dyn/chat_v1.spaces.spaceEvents.html b/docs/dyn/chat_v1.spaces.spaceEvents.html index 98f919d449..9f20b2dafc 100644 --- a/docs/dyn/chat_v1.spaces.spaceEvents.html +++ b/docs/dyn/chat_v1.spaces.spaceEvents.html @@ -3306,7 +3306,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -6379,7 +6379,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -9452,7 +9452,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -12523,7 +12523,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -15592,7 +15592,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -18661,7 +18661,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -18896,7 +18896,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -19007,7 +19007,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -22241,7 +22241,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -25314,7 +25314,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -28387,7 +28387,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -31458,7 +31458,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -34527,7 +34527,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -37596,7 +37596,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -37831,7 +37831,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. @@ -37942,7 +37942,7 @@

Method Details

"predefinedPermissionSettings": "A String", # Optional. Input only. Predefined space permission settings, input only when creating a space. If the field is not set, a collaboration space is created. After you create the space, settings are populated in the `PermissionSettings` field. Setting predefined permission settings supports: - [App authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-app) with [administrator approval](https://support.google.com/a?p=chat-app-auth) with the `chat.app.spaces` or `chat.app.spaces.create` scopes. - [User authentication](https://developers.google.com/workspace/chat/authenticate-authorize-chat-user) "singleUserBotDm": True or False, # Optional. Whether the space is a DM between a Chat app and a single human. "spaceDetails": { # Details about the space including description and rules. # Optional. Details about the space including description and rules. - "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters. + "description": "A String", # Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters. "guidelines": "A String", # Optional. The space's rules, expectations, and etiquette. Supports up to 5,000 characters. }, "spaceHistoryState": "A String", # Optional. The message history state for messages and threads in this space. diff --git a/docs/dyn/cloudsupport_v2.cases.html b/docs/dyn/cloudsupport_v2.cases.html index d4908d1f26..f11c55958f 100644 --- a/docs/dyn/cloudsupport_v2.cases.html +++ b/docs/dyn/cloudsupport_v2.cases.html @@ -137,9 +137,9 @@

Method Details

"displayName": "A String", # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field. "id": "A String", # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail. }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -175,9 +175,9 @@

Method Details

"displayName": "A String", # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field. "id": "A String", # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail. }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -211,9 +211,9 @@

Method Details

"displayName": "A String", # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field. "id": "A String", # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail. }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -264,9 +264,9 @@

Method Details

"displayName": "A String", # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field. "id": "A String", # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail. }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -307,9 +307,9 @@

Method Details

"displayName": "A String", # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field. "id": "A String", # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail. }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -355,9 +355,9 @@

Method Details

"displayName": "A String", # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field. "id": "A String", # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail. }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -410,9 +410,9 @@

Method Details

"displayName": "A String", # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field. "id": "A String", # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail. }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -447,9 +447,9 @@

Method Details

"displayName": "A String", # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field. "id": "A String", # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail. }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -495,9 +495,9 @@

Method Details

"displayName": "A String", # A display name for the classification. The display name is not static and can change. To uniquely and consistently identify classifications, use the `CaseClassification.id` field. "id": "A String", # The unique ID for a classification. Must be specified for case creation. To retrieve valid classification IDs for case creation, use `caseClassifications.search`. Classification IDs returned by `caseClassifications.search` are guaranteed to be valid for at least 6 months. If a given classification is deactiveated, it will immediately stop being returned. After 6 months, `case.create` requests using the classification ID will fail. }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. diff --git a/docs/dyn/cloudsupport_v2beta.cases.html b/docs/dyn/cloudsupport_v2beta.cases.html index ca75fc7d26..15885c906d 100644 --- a/docs/dyn/cloudsupport_v2beta.cases.html +++ b/docs/dyn/cloudsupport_v2beta.cases.html @@ -146,9 +146,9 @@

Method Details

"productLine": "A String", # The product line of the Product. }, }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -188,9 +188,9 @@

Method Details

"productLine": "A String", # The product line of the Product. }, }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -228,9 +228,9 @@

Method Details

"productLine": "A String", # The product line of the Product. }, }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -285,9 +285,9 @@

Method Details

"productLine": "A String", # The product line of the Product. }, }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -332,9 +332,9 @@

Method Details

"productLine": "A String", # The product line of the Product. }, }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -389,9 +389,9 @@

Method Details

"productLine": "A String", # The product line of the Product. }, }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -448,9 +448,9 @@

Method Details

"productLine": "A String", # The product line of the Product. }, }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -489,9 +489,9 @@

Method Details

"productLine": "A String", # The product line of the Product. }, }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. @@ -541,9 +541,9 @@

Method Details

"productLine": "A String", # The product line of the Product. }, }, - "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs. + "contactEmail": "A String", # A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field. "createTime": "A String", # Output only. The time this case was created. - "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support. + "creator": { # An Actor represents an entity that performed an action. For example, an actor could be a user who posted a comment on a support case, a user who uploaded an attachment, or a service account that created a support case. # The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support. "displayName": "A String", # The name to display for the actor. If not provided, it is inferred from credentials supplied during case creation. When an email is provided, a display name must also be provided. This will be obfuscated if the user is a Google Support agent. "email": "A String", # The email address of the actor. If not provided, it is inferred from the credentials supplied during case creation. When a name is provided, an email must also be provided. If the user is a Google Support agent, this is obfuscated. This field is deprecated. Use `username` instead. "googleSupport": True or False, # Output only. Whether the actor is a Google support actor. diff --git a/docs/dyn/container_v1.projects.locations.clusters.html b/docs/dyn/container_v1.projects.locations.clusters.html index b7ad137583..c624daa557 100644 --- a/docs/dyn/container_v1.projects.locations.clusters.html +++ b/docs/dyn/container_v1.projects.locations.clusters.html @@ -563,7 +563,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -2387,7 +2387,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -4068,7 +4068,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -6692,7 +6692,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "desiredCostManagementConfig": { # Configuration for fine-grained cost management feature. # The desired configuration for the fine-grained cost management feature. + "desiredCostManagementConfig": { # Configuration for fine-grained cost allocation feature. # The desired configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. diff --git a/docs/dyn/container_v1.projects.zones.clusters.html b/docs/dyn/container_v1.projects.zones.clusters.html index bea1dfd7b4..0acb1b5142 100644 --- a/docs/dyn/container_v1.projects.zones.clusters.html +++ b/docs/dyn/container_v1.projects.zones.clusters.html @@ -677,7 +677,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -2501,7 +2501,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -4226,7 +4226,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -6719,7 +6719,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "desiredCostManagementConfig": { # Configuration for fine-grained cost management feature. # The desired configuration for the fine-grained cost management feature. + "desiredCostManagementConfig": { # Configuration for fine-grained cost allocation feature. # The desired configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. diff --git a/docs/dyn/container_v1beta1.projects.locations.clusters.html b/docs/dyn/container_v1beta1.projects.locations.clusters.html index e55b763d30..1a6421b72b 100644 --- a/docs/dyn/container_v1beta1.projects.locations.clusters.html +++ b/docs/dyn/container_v1beta1.projects.locations.clusters.html @@ -581,7 +581,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -2495,7 +2495,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -4266,7 +4266,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -6984,7 +6984,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "desiredCostManagementConfig": { # Configuration for fine-grained cost management feature. # The desired configuration for the fine-grained cost management feature. + "desiredCostManagementConfig": { # Configuration for fine-grained cost allocation feature. # The desired configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. diff --git a/docs/dyn/container_v1beta1.projects.zones.clusters.html b/docs/dyn/container_v1beta1.projects.zones.clusters.html index 35e1160a45..347c09c6c3 100644 --- a/docs/dyn/container_v1beta1.projects.zones.clusters.html +++ b/docs/dyn/container_v1beta1.projects.zones.clusters.html @@ -702,7 +702,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -2616,7 +2616,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -4431,7 +4431,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature. + "costManagementConfig": { # Configuration for fine-grained cost allocation feature. # Configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format. @@ -7011,7 +7011,7 @@

Method Details

"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled. }, }, - "desiredCostManagementConfig": { # Configuration for fine-grained cost management feature. # The desired configuration for the fine-grained cost management feature. + "desiredCostManagementConfig": { # Configuration for fine-grained cost allocation feature. # The desired configuration for the fine-grained cost allocation feature. "enabled": True or False, # Whether the feature is enabled or not. }, "desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption. diff --git a/docs/dyn/css_v1.accounts.cssProductInputs.html b/docs/dyn/css_v1.accounts.cssProductInputs.html index af888fb167..64156c5b15 100644 --- a/docs/dyn/css_v1.accounts.cssProductInputs.html +++ b/docs/dyn/css_v1.accounts.cssProductInputs.html @@ -197,8 +197,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. - "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. - "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -233,8 +233,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, - "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. - "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). @@ -345,8 +345,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. - "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. - "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -381,8 +381,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, - "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. - "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). @@ -494,8 +494,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. - "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. - "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -530,8 +530,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, - "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. - "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). @@ -642,8 +642,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. - "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. - "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -678,8 +678,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, - "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. - "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). diff --git a/docs/dyn/css_v1.accounts.cssProducts.html b/docs/dyn/css_v1.accounts.cssProducts.html index 32f87a2c3f..9edf11decf 100644 --- a/docs/dyn/css_v1.accounts.cssProducts.html +++ b/docs/dyn/css_v1.accounts.cssProducts.html @@ -183,8 +183,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. - "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. - "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -219,8 +219,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, - "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. - "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). @@ -373,8 +373,8 @@

Method Details

"currencyCode": "A String", # The currency of the price using three-letter acronyms according to [ISO 4217](http://en.wikipedia.org/wiki/ISO_4217). }, "material": "A String", # The material of which the item is made. - "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. - "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "maxRating": "A String", # Maximum rating score of the product. Required if `rating` is provided. + "minRating": "A String", # Minimum rating score of the product. Required if `rating` is provided. "mpn": "A String", # Manufacturer Part Number ([MPN](https://support.google.com/merchants/answer/188494#mpn)) of the item. "multipack": "A String", # The number of identical products in a merchant-defined multipack. "numberOfOffers": "A String", # The number of CSS Products. @@ -409,8 +409,8 @@

Method Details

"unit": "A String", # Required. The dimension units. Acceptable values are: * "`in`" * "`cm`" "value": 3.14, # Required. The dimension value represented as a number. The value can have a maximum precision of four decimal places. }, - "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used. - "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used. + "rating": 3.14, # Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. + "reviewCount": "A String", # Number of reviews of the product. Required if `rating` is provided. "size": "A String", # Size of the item. Only one value is allowed. For variants with different sizes, insert a separate product for each size with the same `itemGroupId` value (see [https://support.google.com/merchants/answer/6324492](size definition)). "sizeSystem": "A String", # System in which the size is specified. Recommended for apparel items. "sizeTypes": [ # The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see [size type](https://support.google.com/merchants/answer/6324497). diff --git a/docs/dyn/databasecenter_v1beta.v1beta.html b/docs/dyn/databasecenter_v1beta.v1beta.html index 6d6a5765fd..b1c34d5057 100644 --- a/docs/dyn/databasecenter_v1beta.v1beta.html +++ b/docs/dyn/databasecenter_v1beta.v1beta.html @@ -310,8 +310,8 @@

Method Details

The object takes the form of: { # QueryDatabaseResourceGroupsRequest is the request to get a list of database groups. - "filter": "A String", # Optional. The expression to filter resources. The following fields are filterable: * full_resource_name * resource_type * container * product.type * product.engine * product.version * location * labels * resource_category * machine_config.cpu_count * machine_config.memory_size_bytes * machine_config.shard_count * resource_name * tags * backupdr_config.backupdr_managed * edition The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. When `AND` and `OR` are both used in the expression, parentheses must be appropriately used to group the combinations. Example: `location="us-east1"` Example: `container="projects/123" OR container="projects/456"` Example: `(container="projects/123" OR container="projects/456") AND location="us-east1"` Example: `full_resource_name=~"test"` Example: `full_resource_name=~"test.*master"` - "orderBy": "A String", # Optional. A field that specifies the sort order of the results. The following fields are sortable: * full_resource_name * product.type * product.engine * product.version * container * issue_count * machine_config.vcpu_count * machine_config.memory_size_bytes * machine_config.shard_count * resource_name * issue_severity * signal_type * location * resource_type * instance_type * edition * metrics.p99_cpu_utilization * metrics.p95_cpu_utilization * metrics.current_storage_used_bytes * metrics.node_count * metrics.processing_unit_count * metrics.current_memory_used_bytes * metrics.peak_storage_utilization * metrics.peak_number_connections * metrics.peak_memory_utilization The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It only supports a single field at a time. For example: `order_by = "full_resource_name"` sorts response in ascending order `order_by = "full_resource_name DESC"` sorts response in descending order `order_by = "issue_count DESC"` sorts response in descending order of count of all issues associated with a resource. More explicitly, `order_by = "full_resource_name, product"` is not supported. + "filter": "A String", # Optional. The expression to filter resources. The following fields are filterable: * full_resource_name * resource_type * container * product.type * product.engine * product.version * location * labels * resource_category * machine_config.cpu_count * machine_config.memory_size_bytes * machine_config.shard_count * resource_name * tags * backupdr_config.backupdr_managed * edition * modes The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. When `AND` and `OR` are both used in the expression, parentheses must be appropriately used to group the combinations. Example: `location="us-east1"` Example: `container="projects/123" OR container="projects/456"` Example: `(container="projects/123" OR container="projects/456") AND location="us-east1"` Example: `full_resource_name=~"test"` Example: `full_resource_name=~"test.*master"` + "orderBy": "A String", # Optional. A field that specifies the sort order of the results. The following fields are sortable: * full_resource_name * product.type * product.engine * product.version * container * issue_count * machine_config.vcpu_count * machine_config.memory_size_bytes * machine_config.shard_count * resource_name * issue_severity * signal_type * location * resource_type * instance_type * edition * modes * metrics.p99_cpu_utilization * metrics.p95_cpu_utilization * metrics.current_storage_used_bytes * metrics.node_count * metrics.processing_unit_count * metrics.current_memory_used_bytes * metrics.peak_storage_utilization * metrics.peak_number_connections * metrics.peak_memory_utilization The default order is ascending. Add "DESC" after the field name to indicate descending order. Add "ASC" after the field name to indicate ascending order. It only supports a single field at a time. For example: `order_by = "full_resource_name"` sorts response in ascending order `order_by = "full_resource_name DESC"` sorts response in descending order `order_by = "issue_count DESC"` sorts response in descending order of count of all issues associated with a resource. More explicitly, `order_by = "full_resource_name, product"` is not supported. "pageSize": 42, # Optional. If unspecified, at most 50 resource groups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. "pageToken": "A String", # Optional. A page token, received from a previous `QueryDatabaseResourceGroupsRequest` call. Provide this to retrieve the subsequent page. All parameters except page_token should match the parameters in the call that provided the page page token. "parent": "A String", # Required. Parent can be a project, a folder, or an organization. The search is limited to the resources within the `scope`. The allowed values are: * projects/{PROJECT_ID} (e.g., "projects/foo-bar") * projects/{PROJECT_NUMBER} (e.g., "projects/12345678") * folders/{FOLDER_NUMBER} (e.g., "folders/1234567") * organizations/{ORGANIZATION_NUMBER} (e.g., "organizations/123456") diff --git a/docs/dyn/devicerun_v1alpha.projects.locations.sessions.html b/docs/dyn/devicerun_v1alpha.projects.locations.sessions.html index b8531afabf..bf0d8256fd 100644 --- a/docs/dyn/devicerun_v1alpha.projects.locations.sessions.html +++ b/docs/dyn/devicerun_v1alpha.projects.locations.sessions.html @@ -181,10 +181,10 @@

Method Details

"path": "A String", # Required. The Google Cloud Storage path of the file or directory. Format: `gs:///`. }, }, - "args": [ # Optional. Arguments for running the binary file. The flags will be appended to the command line that invokes the binary. The number of options is limited to 100. + "args": [ # Optional. Arguments for running the binary file. The flags will be appended to the command line that invokes the binary. Limits: - Maximum number of entries: 64 - Maximum entry size: 1024 bytes (UTF-8) "A String", ], - "envVars": { # Optional. A map of environment variables to set for the binary process. The keys are the variable names and the values are the variable values. The maximum number of entries is 100. Each key is limited to 128 characters and must conform to POSIX standards. Each value is limited to 2048 characters. The total size of all environment variables must not exceed 16 KiB. + "envVars": { # Optional. A map of environment variables to set for the binary process. The keys are the variable names and the values are the variable values. Limits: - Maximum number of entries: 32 - Maximum key size: 64 bytes (UTF-8) - Key regex: `a-zA-Z_*` - Maximum value size: 1024 bytes (UTF-8) "a_key": "A String", }, "executionTimeout": "A String", # Optional. The timeout of the execution. Default value: 5 min. Range: [1 min, 3 hours]. @@ -604,10 +604,10 @@

Method Details

"path": "A String", # Required. The Google Cloud Storage path of the file or directory. Format: `gs:///`. }, }, - "args": [ # Optional. Arguments for running the binary file. The flags will be appended to the command line that invokes the binary. The number of options is limited to 100. + "args": [ # Optional. Arguments for running the binary file. The flags will be appended to the command line that invokes the binary. Limits: - Maximum number of entries: 64 - Maximum entry size: 1024 bytes (UTF-8) "A String", ], - "envVars": { # Optional. A map of environment variables to set for the binary process. The keys are the variable names and the values are the variable values. The maximum number of entries is 100. Each key is limited to 128 characters and must conform to POSIX standards. Each value is limited to 2048 characters. The total size of all environment variables must not exceed 16 KiB. + "envVars": { # Optional. A map of environment variables to set for the binary process. The keys are the variable names and the values are the variable values. Limits: - Maximum number of entries: 32 - Maximum key size: 64 bytes (UTF-8) - Key regex: `a-zA-Z_*` - Maximum value size: 1024 bytes (UTF-8) "a_key": "A String", }, "executionTimeout": "A String", # Optional. The timeout of the execution. Default value: 5 min. Range: [1 min, 3 hours]. @@ -968,10 +968,10 @@

Method Details

"path": "A String", # Required. The Google Cloud Storage path of the file or directory. Format: `gs:///`. }, }, - "args": [ # Optional. Arguments for running the binary file. The flags will be appended to the command line that invokes the binary. The number of options is limited to 100. + "args": [ # Optional. Arguments for running the binary file. The flags will be appended to the command line that invokes the binary. Limits: - Maximum number of entries: 64 - Maximum entry size: 1024 bytes (UTF-8) "A String", ], - "envVars": { # Optional. A map of environment variables to set for the binary process. The keys are the variable names and the values are the variable values. The maximum number of entries is 100. Each key is limited to 128 characters and must conform to POSIX standards. Each value is limited to 2048 characters. The total size of all environment variables must not exceed 16 KiB. + "envVars": { # Optional. A map of environment variables to set for the binary process. The keys are the variable names and the values are the variable values. Limits: - Maximum number of entries: 32 - Maximum key size: 64 bytes (UTF-8) - Key regex: `a-zA-Z_*` - Maximum value size: 1024 bytes (UTF-8) "a_key": "A String", }, "executionTimeout": "A String", # Optional. The timeout of the execution. Default value: 5 min. Range: [1 min, 3 hours]. diff --git a/docs/dyn/fcm_v1.projects.messages.html b/docs/dyn/fcm_v1.projects.messages.html index 6cdc9b24cd..28460efa43 100644 --- a/docs/dyn/fcm_v1.projects.messages.html +++ b/docs/dyn/fcm_v1.projects.messages.html @@ -79,7 +79,7 @@

Instance Methods

Close httplib2 connections.

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

-

Send a message to specified target (a [Firebase Installation ID (FID)](/docs/cloud-messaging/android/get-started#access-firebase-installation-id), registration token, topic, or condition).

+

Send a message to specified target (a [Firebase Installation ID (FID)](/docs/cloud-messaging/android/get-started#access-firebase-installation-id), registration token, topic, or condition). If duplicate fields or parameters are provided in a request (such as repeated JSON keys in the request body or duplicate query parameters), the last occurrence takes precedence.

Method Details

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

Method Details

send(parent, body=None, x__xgafv=None) -
Send a message to specified target (a [Firebase Installation ID (FID)](/docs/cloud-messaging/android/get-started#access-firebase-installation-id), registration token, topic, or condition).
+  
Send a message to specified target (a [Firebase Installation ID (FID)](/docs/cloud-messaging/android/get-started#access-firebase-installation-id), registration token, topic, or condition). If duplicate fields or parameters are provided in a request (such as repeated JSON keys in the request body or duplicate query parameters), the last occurrence takes precedence.
 
 Args:
   parent: string, Required. It contains the Firebase project id (i.e. the unique identifier for your Firebase project), in the format of `projects/{project_id}`. The numeric project number with no padding is also supported in the format of `projects/{project_number}`. (required)
diff --git a/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html b/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html
index cd023fcf55..d9c96cbd85 100644
--- a/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html
+++ b/docs/dyn/firestore_v1.projects.databases.collectionGroups.fields.html
@@ -148,7 +148,7 @@ 

Method Details

"textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. }, - "shardCount": 42, # Optional. The number of shards for the index. + "shardCount": 42, # Optional. The number of physical shards for the index. In Cloud Firestore, data and index entries are stored in contiguous, ordered key ranges called splits. While document keys within a collection are hashed to distribute write traffic across splits, secondary index entries are ordered lexicographically by their indexed field values. When an index contains fields with sequential or monotonically increasing or decreasing values (such as timestamps or auto-incrementing IDs), every incoming index write targets the boundary of the index keyspace on a single split. Because sequential writes continuously advance to the newest split at the edge of the range, automatic load-based splitting cannot divide the write traffic across storage servers. Under high write rates, this concentration creates an append hotspot on that single split, resulting in elevated write latency, contention errors, and transaction aborts. Sharded indexes solve this write bottleneck by hash partitioning the secondary index keyspace. When `shard_count` is configured to N, Firestore automatically prepends a virtual computed shard field (with values from 0 to N-1) as the leading field of the index. This splits a single sequential key range into N independent key ranges, uniformly scattering adjacent writes across distinct splits and storage servers to enable linear write scaling. Query trade-offs: Hash partitioning trades query performance for write throughput. Because matching index entries are scattered across all shards, queries executing against a sharded index cannot read from a single contiguous range. The query engine must fan out parallel seeks across all N shards and merge the ordered results. Even index point lookups and queries with `LIMIT 1` must seek across all N shards. Sizing and best practices: - Indexes cannot be updated in-place. `shard_count` is immutable once an index is created; to "reshard" an index, create a new index with the desired `shard_count` and delete the original index. - Use sharded indexes only for indexes experiencing write bottlenecks (typically exceeding 500-1,000 writes/sec) on sequential or timestamp fields. - Do not shard indexes on uniformly distributed fields (such as UUIDs or hash tokens), where writes naturally spread across splits without sharding. Sharding uniform indexes adds query overhead without improving write throughput. - Do not shard read-heavy or low-write collections. - Size `shard_count` based on expected peak write throughput. Because a single split sustains roughly 500-1,000 writes/sec on sequential keys, estimate `shard_count ≈ ceil(peak_write_qps / 500)`. - e.g., 4 for up to ~2,000-4,000 writes/sec, 16 for up to ~10,000+ writes/sec. - Setting an excessively high shard count produces diminishing write returns while needlessly increasing read latency and seek costs. If <= 1, the index is unsharded (1 physical shard). "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. }, @@ -222,7 +222,7 @@

Method Details

"textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. }, - "shardCount": 42, # Optional. The number of shards for the index. + "shardCount": 42, # Optional. The number of physical shards for the index. In Cloud Firestore, data and index entries are stored in contiguous, ordered key ranges called splits. While document keys within a collection are hashed to distribute write traffic across splits, secondary index entries are ordered lexicographically by their indexed field values. When an index contains fields with sequential or monotonically increasing or decreasing values (such as timestamps or auto-incrementing IDs), every incoming index write targets the boundary of the index keyspace on a single split. Because sequential writes continuously advance to the newest split at the edge of the range, automatic load-based splitting cannot divide the write traffic across storage servers. Under high write rates, this concentration creates an append hotspot on that single split, resulting in elevated write latency, contention errors, and transaction aborts. Sharded indexes solve this write bottleneck by hash partitioning the secondary index keyspace. When `shard_count` is configured to N, Firestore automatically prepends a virtual computed shard field (with values from 0 to N-1) as the leading field of the index. This splits a single sequential key range into N independent key ranges, uniformly scattering adjacent writes across distinct splits and storage servers to enable linear write scaling. Query trade-offs: Hash partitioning trades query performance for write throughput. Because matching index entries are scattered across all shards, queries executing against a sharded index cannot read from a single contiguous range. The query engine must fan out parallel seeks across all N shards and merge the ordered results. Even index point lookups and queries with `LIMIT 1` must seek across all N shards. Sizing and best practices: - Indexes cannot be updated in-place. `shard_count` is immutable once an index is created; to "reshard" an index, create a new index with the desired `shard_count` and delete the original index. - Use sharded indexes only for indexes experiencing write bottlenecks (typically exceeding 500-1,000 writes/sec) on sequential or timestamp fields. - Do not shard indexes on uniformly distributed fields (such as UUIDs or hash tokens), where writes naturally spread across splits without sharding. Sharding uniform indexes adds query overhead without improving write throughput. - Do not shard read-heavy or low-write collections. - Size `shard_count` based on expected peak write throughput. Because a single split sustains roughly 500-1,000 writes/sec on sequential keys, estimate `shard_count ≈ ceil(peak_write_qps / 500)`. - e.g., 4 for up to ~2,000-4,000 writes/sec, 16 for up to ~10,000+ writes/sec. - Setting an excessively high shard count produces diminishing write returns while needlessly increasing read latency and seek costs. If <= 1, the index is unsharded (1 physical shard). "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. }, @@ -303,7 +303,7 @@

Method Details

"textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. }, - "shardCount": 42, # Optional. The number of shards for the index. + "shardCount": 42, # Optional. The number of physical shards for the index. In Cloud Firestore, data and index entries are stored in contiguous, ordered key ranges called splits. While document keys within a collection are hashed to distribute write traffic across splits, secondary index entries are ordered lexicographically by their indexed field values. When an index contains fields with sequential or monotonically increasing or decreasing values (such as timestamps or auto-incrementing IDs), every incoming index write targets the boundary of the index keyspace on a single split. Because sequential writes continuously advance to the newest split at the edge of the range, automatic load-based splitting cannot divide the write traffic across storage servers. Under high write rates, this concentration creates an append hotspot on that single split, resulting in elevated write latency, contention errors, and transaction aborts. Sharded indexes solve this write bottleneck by hash partitioning the secondary index keyspace. When `shard_count` is configured to N, Firestore automatically prepends a virtual computed shard field (with values from 0 to N-1) as the leading field of the index. This splits a single sequential key range into N independent key ranges, uniformly scattering adjacent writes across distinct splits and storage servers to enable linear write scaling. Query trade-offs: Hash partitioning trades query performance for write throughput. Because matching index entries are scattered across all shards, queries executing against a sharded index cannot read from a single contiguous range. The query engine must fan out parallel seeks across all N shards and merge the ordered results. Even index point lookups and queries with `LIMIT 1` must seek across all N shards. Sizing and best practices: - Indexes cannot be updated in-place. `shard_count` is immutable once an index is created; to "reshard" an index, create a new index with the desired `shard_count` and delete the original index. - Use sharded indexes only for indexes experiencing write bottlenecks (typically exceeding 500-1,000 writes/sec) on sequential or timestamp fields. - Do not shard indexes on uniformly distributed fields (such as UUIDs or hash tokens), where writes naturally spread across splits without sharding. Sharding uniform indexes adds query overhead without improving write throughput. - Do not shard read-heavy or low-write collections. - Size `shard_count` based on expected peak write throughput. Because a single split sustains roughly 500-1,000 writes/sec on sequential keys, estimate `shard_count ≈ ceil(peak_write_qps / 500)`. - e.g., 4 for up to ~2,000-4,000 writes/sec, 16 for up to ~10,000+ writes/sec. - Setting an excessively high shard count produces diminishing write returns while needlessly increasing read latency and seek costs. If <= 1, the index is unsharded (1 physical shard). "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. }, diff --git a/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html b/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html index 2e73d5cd11..42b7cb181d 100644 --- a/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html +++ b/docs/dyn/firestore_v1.projects.databases.collectionGroups.indexes.html @@ -142,7 +142,7 @@

Method Details

"textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. }, - "shardCount": 42, # Optional. The number of shards for the index. + "shardCount": 42, # Optional. The number of physical shards for the index. In Cloud Firestore, data and index entries are stored in contiguous, ordered key ranges called splits. While document keys within a collection are hashed to distribute write traffic across splits, secondary index entries are ordered lexicographically by their indexed field values. When an index contains fields with sequential or monotonically increasing or decreasing values (such as timestamps or auto-incrementing IDs), every incoming index write targets the boundary of the index keyspace on a single split. Because sequential writes continuously advance to the newest split at the edge of the range, automatic load-based splitting cannot divide the write traffic across storage servers. Under high write rates, this concentration creates an append hotspot on that single split, resulting in elevated write latency, contention errors, and transaction aborts. Sharded indexes solve this write bottleneck by hash partitioning the secondary index keyspace. When `shard_count` is configured to N, Firestore automatically prepends a virtual computed shard field (with values from 0 to N-1) as the leading field of the index. This splits a single sequential key range into N independent key ranges, uniformly scattering adjacent writes across distinct splits and storage servers to enable linear write scaling. Query trade-offs: Hash partitioning trades query performance for write throughput. Because matching index entries are scattered across all shards, queries executing against a sharded index cannot read from a single contiguous range. The query engine must fan out parallel seeks across all N shards and merge the ordered results. Even index point lookups and queries with `LIMIT 1` must seek across all N shards. Sizing and best practices: - Indexes cannot be updated in-place. `shard_count` is immutable once an index is created; to "reshard" an index, create a new index with the desired `shard_count` and delete the original index. - Use sharded indexes only for indexes experiencing write bottlenecks (typically exceeding 500-1,000 writes/sec) on sequential or timestamp fields. - Do not shard indexes on uniformly distributed fields (such as UUIDs or hash tokens), where writes naturally spread across splits without sharding. Sharding uniform indexes adds query overhead without improving write throughput. - Do not shard read-heavy or low-write collections. - Size `shard_count` based on expected peak write throughput. Because a single split sustains roughly 500-1,000 writes/sec on sequential keys, estimate `shard_count ≈ ceil(peak_write_qps / 500)`. - e.g., 4 for up to ~2,000-4,000 writes/sec, 16 for up to ~10,000+ writes/sec. - Setting an excessively high shard count produces diminishing write returns while needlessly increasing read latency and seek costs. If <= 1, the index is unsharded (1 physical shard). "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. } @@ -243,7 +243,7 @@

Method Details

"textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. }, - "shardCount": 42, # Optional. The number of shards for the index. + "shardCount": 42, # Optional. The number of physical shards for the index. In Cloud Firestore, data and index entries are stored in contiguous, ordered key ranges called splits. While document keys within a collection are hashed to distribute write traffic across splits, secondary index entries are ordered lexicographically by their indexed field values. When an index contains fields with sequential or monotonically increasing or decreasing values (such as timestamps or auto-incrementing IDs), every incoming index write targets the boundary of the index keyspace on a single split. Because sequential writes continuously advance to the newest split at the edge of the range, automatic load-based splitting cannot divide the write traffic across storage servers. Under high write rates, this concentration creates an append hotspot on that single split, resulting in elevated write latency, contention errors, and transaction aborts. Sharded indexes solve this write bottleneck by hash partitioning the secondary index keyspace. When `shard_count` is configured to N, Firestore automatically prepends a virtual computed shard field (with values from 0 to N-1) as the leading field of the index. This splits a single sequential key range into N independent key ranges, uniformly scattering adjacent writes across distinct splits and storage servers to enable linear write scaling. Query trade-offs: Hash partitioning trades query performance for write throughput. Because matching index entries are scattered across all shards, queries executing against a sharded index cannot read from a single contiguous range. The query engine must fan out parallel seeks across all N shards and merge the ordered results. Even index point lookups and queries with `LIMIT 1` must seek across all N shards. Sizing and best practices: - Indexes cannot be updated in-place. `shard_count` is immutable once an index is created; to "reshard" an index, create a new index with the desired `shard_count` and delete the original index. - Use sharded indexes only for indexes experiencing write bottlenecks (typically exceeding 500-1,000 writes/sec) on sequential or timestamp fields. - Do not shard indexes on uniformly distributed fields (such as UUIDs or hash tokens), where writes naturally spread across splits without sharding. Sharding uniform indexes adds query overhead without improving write throughput. - Do not shard read-heavy or low-write collections. - Size `shard_count` based on expected peak write throughput. Because a single split sustains roughly 500-1,000 writes/sec on sequential keys, estimate `shard_count ≈ ceil(peak_write_qps / 500)`. - e.g., 4 for up to ~2,000-4,000 writes/sec, 16 for up to ~10,000+ writes/sec. - Setting an excessively high shard count produces diminishing write returns while needlessly increasing read latency and seek costs. If <= 1, the index is unsharded (1 physical shard). "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. }
@@ -303,7 +303,7 @@

Method Details

"textLanguage": "A String", # Optional. The language to use for text search indexes. Used as the default language if not overridden at the document level by specifying the `text_language_override_field`. The language is specified as a BCP 47 language code. For indexes with MONGODB_COMPATIBLE_API ApiScope: If unspecified, the default language is English. For indexes with `ANY_API` ApiScope: If unspecified, the default behavior is autodetect. "textLanguageOverrideFieldPath": "A String", # Optional. The field in the document that specifies which language to use for that specific document. For indexes with MONGODB_COMPATIBLE_API ApiScope: if unspecified, the language is taken from the "language" field if it exists or from `text_language` if it does not. }, - "shardCount": 42, # Optional. The number of shards for the index. + "shardCount": 42, # Optional. The number of physical shards for the index. In Cloud Firestore, data and index entries are stored in contiguous, ordered key ranges called splits. While document keys within a collection are hashed to distribute write traffic across splits, secondary index entries are ordered lexicographically by their indexed field values. When an index contains fields with sequential or monotonically increasing or decreasing values (such as timestamps or auto-incrementing IDs), every incoming index write targets the boundary of the index keyspace on a single split. Because sequential writes continuously advance to the newest split at the edge of the range, automatic load-based splitting cannot divide the write traffic across storage servers. Under high write rates, this concentration creates an append hotspot on that single split, resulting in elevated write latency, contention errors, and transaction aborts. Sharded indexes solve this write bottleneck by hash partitioning the secondary index keyspace. When `shard_count` is configured to N, Firestore automatically prepends a virtual computed shard field (with values from 0 to N-1) as the leading field of the index. This splits a single sequential key range into N independent key ranges, uniformly scattering adjacent writes across distinct splits and storage servers to enable linear write scaling. Query trade-offs: Hash partitioning trades query performance for write throughput. Because matching index entries are scattered across all shards, queries executing against a sharded index cannot read from a single contiguous range. The query engine must fan out parallel seeks across all N shards and merge the ordered results. Even index point lookups and queries with `LIMIT 1` must seek across all N shards. Sizing and best practices: - Indexes cannot be updated in-place. `shard_count` is immutable once an index is created; to "reshard" an index, create a new index with the desired `shard_count` and delete the original index. - Use sharded indexes only for indexes experiencing write bottlenecks (typically exceeding 500-1,000 writes/sec) on sequential or timestamp fields. - Do not shard indexes on uniformly distributed fields (such as UUIDs or hash tokens), where writes naturally spread across splits without sharding. Sharding uniform indexes adds query overhead without improving write throughput. - Do not shard read-heavy or low-write collections. - Size `shard_count` based on expected peak write throughput. Because a single split sustains roughly 500-1,000 writes/sec on sequential keys, estimate `shard_count ≈ ceil(peak_write_qps / 500)`. - e.g., 4 for up to ~2,000-4,000 writes/sec, 16 for up to ~10,000+ writes/sec. - Setting an excessively high shard count produces diminishing write returns while needlessly increasing read latency and seek costs. If <= 1, the index is unsharded (1 physical shard). "state": "A String", # Output only. The serving state of the index. "unique": True or False, # Optional. Whether it is an unique index. Unique index ensures all values for the indexed field(s) are unique across documents. }, diff --git a/docs/dyn/merchantapi_accounts_v1.accounts.programs.html b/docs/dyn/merchantapi_accounts_v1.accounts.programs.html index 7dfca0005b..f4d750d27a 100644 --- a/docs/dyn/merchantapi_accounts_v1.accounts.programs.html +++ b/docs/dyn/merchantapi_accounts_v1.accounts.programs.html @@ -123,7 +123,7 @@

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `ucp-integration` (limited access) * `youtube-affiliate` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * [`checkout`](https://developers.google.com/merchant/api/guides/products/checkout-settings) * `free-listings` * [`loyalty`](https://developers.google.com/merchant/api/guides/loyalty/loyalty-programs) * `product-ratings` * `shopping-ads` * [`ucp-integration` (limited access)](https://developers.google.com/merchant/api/reference/rest/accounts_v1alpha/accounts.programs.ucpSettings) * [`youtube-affiliate`](https://support.google.com/merchants/answer/14815513) * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -162,7 +162,7 @@

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `ucp-integration` (limited access) * `youtube-affiliate` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * [`checkout`](https://developers.google.com/merchant/api/guides/products/checkout-settings) * `free-listings` * [`loyalty`](https://developers.google.com/merchant/api/guides/loyalty/loyalty-programs) * `product-ratings` * `shopping-ads` * [`ucp-integration` (limited access)](https://developers.google.com/merchant/api/reference/rest/accounts_v1alpha/accounts.programs.ucpSettings) * [`youtube-affiliate`](https://support.google.com/merchants/answer/14815513) * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -195,7 +195,7 @@

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `ucp-integration` (limited access) * `youtube-affiliate` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * [`checkout`](https://developers.google.com/merchant/api/guides/products/checkout-settings) * `free-listings` * [`loyalty`](https://developers.google.com/merchant/api/guides/loyalty/loyalty-programs) * `product-ratings` * `shopping-ads` * [`ucp-integration` (limited access)](https://developers.google.com/merchant/api/reference/rest/accounts_v1alpha/accounts.programs.ucpSettings) * [`youtube-affiliate`](https://support.google.com/merchants/answer/14815513) * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -233,7 +233,7 @@

Method Details

{ # Response message for the ListPrograms method. "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "programs": [ # The programs for the given account. - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `ucp-integration` (limited access) * `youtube-affiliate` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * [`checkout`](https://developers.google.com/merchant/api/guides/products/checkout-settings) * `free-listings` * [`loyalty`](https://developers.google.com/merchant/api/guides/loyalty/loyalty-programs) * `product-ratings` * `shopping-ads` * [`ucp-integration` (limited access)](https://developers.google.com/merchant/api/reference/rest/accounts_v1alpha/accounts.programs.ucpSettings) * [`youtube-affiliate`](https://support.google.com/merchants/answer/14815513) * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], diff --git a/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html b/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html index b7a76d4781..2b9768a968 100644 --- a/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html +++ b/docs/dyn/merchantapi_accounts_v1beta.accounts.programs.html @@ -123,7 +123,7 @@

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `ucp-integration` (limited access) * `youtube-affiliate` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * [`checkout`](https://developers.google.com/merchant/api/guides/products/checkout-settings) * `free-listings` * [`loyalty`](https://developers.google.com/merchant/api/guides/loyalty/loyalty-programs) * `product-ratings` * `shopping-ads` * [`ucp-integration` (limited access)](https://developers.google.com/merchant/api/reference/rest/accounts_v1alpha/accounts.programs.ucpSettings) * [`youtube-affiliate`](https://support.google.com/merchants/answer/14815513) * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -162,7 +162,7 @@

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `ucp-integration` (limited access) * `youtube-affiliate` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * [`checkout`](https://developers.google.com/merchant/api/guides/products/checkout-settings) * `free-listings` * [`loyalty`](https://developers.google.com/merchant/api/guides/loyalty/loyalty-programs) * `product-ratings` * `shopping-ads` * [`ucp-integration` (limited access)](https://developers.google.com/merchant/api/reference/rest/accounts_v1alpha/accounts.programs.ucpSettings) * [`youtube-affiliate`](https://support.google.com/merchants/answer/14815513) * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -195,7 +195,7 @@

Method Details

Returns: An object of the form: - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `ucp-integration` (limited access) * `youtube-affiliate` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * [`checkout`](https://developers.google.com/merchant/api/guides/products/checkout-settings) * `free-listings` * [`loyalty`](https://developers.google.com/merchant/api/guides/loyalty/loyalty-programs) * `product-ratings` * `shopping-ads` * [`ucp-integration` (limited access)](https://developers.google.com/merchant/api/reference/rest/accounts_v1alpha/accounts.programs.ucpSettings) * [`youtube-affiliate`](https://support.google.com/merchants/answer/14815513) * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], @@ -233,7 +233,7 @@

Method Details

{ # Response message for the ListPrograms method. "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. "programs": [ # The programs for the given account. - { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `ucp-integration` (limited access) * `youtube-affiliate` * `youtube-shopping-checkout` + { # Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * [`checkout`](https://developers.google.com/merchant/api/guides/products/checkout-settings) * `free-listings` * [`loyalty`](https://developers.google.com/merchant/api/guides/loyalty/loyalty-programs) * `product-ratings` * `shopping-ads` * [`ucp-integration` (limited access)](https://developers.google.com/merchant/api/reference/rest/accounts_v1alpha/accounts.programs.ucpSettings) * [`youtube-affiliate`](https://support.google.com/merchants/answer/14815513) * `youtube-shopping-checkout` "activeRegionCodes": [ # Output only. The regions in which the account is actively participating in the program. Active regions are defined as those where all program requirements affecting the regions have been met. Region codes are defined by [CLDR](https://cldr.unicode.org/). This is either a country where the program applies specifically to that country or `001` when the program applies globally. "A String", ], diff --git a/docs/dyn/run_v1.namespaces.configurations.html b/docs/dyn/run_v1.namespaces.configurations.html index 5bea3ceddc..cc1409eba3 100644 --- a/docs/dyn/run_v1.namespaces.configurations.html +++ b/docs/dyn/run_v1.namespaces.configurations.html @@ -389,8 +389,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -744,8 +744,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. diff --git a/docs/dyn/run_v1.namespaces.executions.html b/docs/dyn/run_v1.namespaces.executions.html index 8d69017c14..69fc870f4a 100644 --- a/docs/dyn/run_v1.namespaces.executions.html +++ b/docs/dyn/run_v1.namespaces.executions.html @@ -360,8 +360,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -724,8 +724,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1049,8 +1049,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. diff --git a/docs/dyn/run_v1.namespaces.instances.html b/docs/dyn/run_v1.namespaces.instances.html index dfe343355a..adfe342f41 100644 --- a/docs/dyn/run_v1.namespaces.instances.html +++ b/docs/dyn/run_v1.namespaces.instances.html @@ -357,8 +357,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -654,8 +654,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1002,8 +1002,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1315,8 +1315,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1624,8 +1624,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1921,8 +1921,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -2231,8 +2231,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -2541,8 +2541,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. diff --git a/docs/dyn/run_v1.namespaces.jobs.html b/docs/dyn/run_v1.namespaces.jobs.html index 52e4bca91e..b39cd2a0a0 100644 --- a/docs/dyn/run_v1.namespaces.jobs.html +++ b/docs/dyn/run_v1.namespaces.jobs.html @@ -396,8 +396,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -743,8 +743,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1141,8 +1141,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1504,8 +1504,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1863,8 +1863,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -2210,8 +2210,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -2571,8 +2571,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. diff --git a/docs/dyn/run_v1.namespaces.revisions.html b/docs/dyn/run_v1.namespaces.revisions.html index b77aecf5a5..40583a6b58 100644 --- a/docs/dyn/run_v1.namespaces.revisions.html +++ b/docs/dyn/run_v1.namespaces.revisions.html @@ -403,8 +403,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -724,8 +724,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. diff --git a/docs/dyn/run_v1.namespaces.services.html b/docs/dyn/run_v1.namespaces.services.html index 9e873de37d..c71122c0a3 100644 --- a/docs/dyn/run_v1.namespaces.services.html +++ b/docs/dyn/run_v1.namespaces.services.html @@ -393,8 +393,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -756,8 +756,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1170,8 +1170,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1549,8 +1549,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1924,8 +1924,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -2287,8 +2287,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. diff --git a/docs/dyn/run_v1.namespaces.tasks.html b/docs/dyn/run_v1.namespaces.tasks.html index 0115ad2729..2badb2aee9 100644 --- a/docs/dyn/run_v1.namespaces.tasks.html +++ b/docs/dyn/run_v1.namespaces.tasks.html @@ -348,8 +348,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -676,8 +676,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. diff --git a/docs/dyn/run_v1.namespaces.workerpools.html b/docs/dyn/run_v1.namespaces.workerpools.html index 296a75206c..3b216e9177 100644 --- a/docs/dyn/run_v1.namespaces.workerpools.html +++ b/docs/dyn/run_v1.namespaces.workerpools.html @@ -400,8 +400,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -753,8 +753,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1154,8 +1154,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1519,8 +1519,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1884,8 +1884,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -2237,8 +2237,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. diff --git a/docs/dyn/run_v1.projects.locations.configurations.html b/docs/dyn/run_v1.projects.locations.configurations.html index 5243b651b4..8ef3084e3e 100644 --- a/docs/dyn/run_v1.projects.locations.configurations.html +++ b/docs/dyn/run_v1.projects.locations.configurations.html @@ -389,8 +389,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -744,8 +744,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. diff --git a/docs/dyn/run_v1.projects.locations.revisions.html b/docs/dyn/run_v1.projects.locations.revisions.html index 8678181c22..e176aa55be 100644 --- a/docs/dyn/run_v1.projects.locations.revisions.html +++ b/docs/dyn/run_v1.projects.locations.revisions.html @@ -403,8 +403,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -724,8 +724,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. diff --git a/docs/dyn/run_v1.projects.locations.services.html b/docs/dyn/run_v1.projects.locations.services.html index fa6ac6041e..27e69e84e4 100644 --- a/docs/dyn/run_v1.projects.locations.services.html +++ b/docs/dyn/run_v1.projects.locations.services.html @@ -402,8 +402,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -765,8 +765,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1179,8 +1179,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1606,8 +1606,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -1981,8 +1981,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. @@ -2344,8 +2344,8 @@

Method Details

"a_key": "A String", }, }, - "emptyDir": { # In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. - "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir + "emptyDir": { # In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs). # Ephemeral storage used as a shared volume. + "medium": "A String", # The medium on which the data is stored. The default is "" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir "sizeLimit": "A String", # Limit on the storage usable by this EmptyDir volume. The size limit is also applicable for memory medium. The maximum usage on memory medium EmptyDir would be the minimum value between the SizeLimit specified here and the sum of memory limits of all containers. The default is nil which means that the limit is undefined. More info: https://cloud.google.com/run/docs/configuring/in-memory-volumes#configure-volume. Info in Kubernetes: https://kubernetes.io/docs/concepts/storage/volumes/#emptydir }, "name": "A String", # Volume's name. In Cloud Run Fully Managed, the name 'cloudsql' is reserved. diff --git a/docs/dyn/sqladmin_v1.workloadCaptures.html b/docs/dyn/sqladmin_v1.workloadCaptures.html index 231e0465f4..9f165d415f 100644 --- a/docs/dyn/sqladmin_v1.workloadCaptures.html +++ b/docs/dyn/sqladmin_v1.workloadCaptures.html @@ -330,7 +330,7 @@

Method Details

The object takes the form of: { # Request to start executing a captured workload on a replay instance (the Cloud SQL instance where the recorded SQL queries are executed). - "startWorkloadReplayContext": { # The context for the `StartWorkloadReplay` operation, which contains details about starting the execution of a captured workload (recorded read and write SQL queries) on a replay instance (the Cloud SQL instance where the recorded SQL queries are executed). # Optional. Contains details about the start workload replay operation. + "startWorkloadReplayContext": { # The context for the `StartWorkloadReplay` operation, which contains details about starting the execution of a captured workload (recorded read and write SQL queries) on a replay instance (the Cloud SQL instance where the recorded SQL queries are executed). # Required. Contains details about the start workload replay operation. "replayInstance": "A String", # Required. The name of the Cloud SQL instance where the captured workload (SQL queries) is being executed, excluding the project ID (for example, `my-replay-instance`). The instance name must start with a lowercase letter and contain only lowercase letters, numbers, and hyphens. The combined length of `project-ID:instance-name` must be 98 characters or less. "workloadId": "A String", # Output only. The ID of the workload to start executing on the replay instance. Each workload capture generates a unique ID in the format `workload-` (for example, `workload-1786046400`). Use this ID to start executing the recorded SQL queries. }, @@ -708,7 +708,7 @@

Method Details

The object takes the form of: { # Request to stop executing a captured workload on a replay instance. - "stopWorkloadReplayContext": { # The context for the `StopWorkloadReplay` operation, which contains details about stopping the execution of a captured workload (recorded read and write SQL queries) on a replay instance. # Optional. Contains details about the stop workload replay operation. + "stopWorkloadReplayContext": { # The context for the `StopWorkloadReplay` operation, which contains details about stopping the execution of a captured workload (recorded read and write SQL queries) on a replay instance. # Required. Contains details about the stop workload replay operation. "replayInstance": "A String", # Required. The name of the Cloud SQL instance where the captured workload (SQL queries) is being executed, excluding the project ID (for example, `my-replay-instance`). The instance name must start with a lowercase letter and contain only lowercase letters, numbers, and hyphens. The combined length of `project-ID:instance-name` must be 98 characters or less. "workloadId": "A String", # Output only. The ID of the workload to stop executing on the replay instance. Each workload capture generates a unique ID in the format `workload-` (for example, `workload-1786046400`). Use this ID to stop executing the recorded SQL queries. }, diff --git a/docs/dyn/vmwareengine_v1.projects.locations.dnsBindPermission.html b/docs/dyn/vmwareengine_v1.projects.locations.dnsBindPermission.html index 9503358c3a..00a5cf1fb4 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.dnsBindPermission.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.dnsBindPermission.html @@ -99,7 +99,7 @@

Method Details

The object takes the form of: { # Request message for VmwareEngine.GrantDnsBindPermission - "principal": { # Users/Service accounts which have access for DNS binding on the intranet VPC corresponding to the consumer project. # Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project. + "principal": { # Users/Service accounts which have access for DNS binding on the intranet VPC corresponding to the consumer project. Principal can be a user or a service account. For example: For specifying user `user@example.com` use `{"user": "user@example.com"}` and for specifying service account `service-account@gserviceaccount.com` use `{"serviceAccount": "service-account@gserviceaccount.com"}`. # Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project. Principal can be a user or a service account. For example, to specify the user `user@example.com`, use `"principal": {"user": "user@example.com"}` and to specify the service account `service-account@gserviceaccount.com`, use `"principal": {"serviceAccount": "service-account@gserviceaccount.com"}`. "serviceAccount": "A String", # The service account which needs to be granted the permission. "user": "A String", # The user who needs to be granted permission. }, @@ -145,7 +145,7 @@

Method Details

The object takes the form of: { # Request message for VmwareEngine.RevokeDnsBindPermission - "principal": { # Users/Service accounts which have access for DNS binding on the intranet VPC corresponding to the consumer project. # Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project. + "principal": { # Users/Service accounts which have access for DNS binding on the intranet VPC corresponding to the consumer project. Principal can be a user or a service account. For example: For specifying user `user@example.com` use `{"user": "user@example.com"}` and for specifying service account `service-account@gserviceaccount.com` use `{"serviceAccount": "service-account@gserviceaccount.com"}`. # Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project. Principal can be a user or a service account. For example, to specify the user `user@example.com`, use `"principal": {"user": "user@example.com"}` and to specify the service account `service-account@gserviceaccount.com`, use `"principal": {"serviceAccount": "service-account@gserviceaccount.com"}`. "serviceAccount": "A String", # The service account which needs to be granted the permission. "user": "A String", # The user who needs to be granted permission. }, diff --git a/docs/dyn/vmwareengine_v1.projects.locations.html b/docs/dyn/vmwareengine_v1.projects.locations.html index 4051cb49cf..820d7d2d99 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.html @@ -189,7 +189,7 @@

Method Details

{ # DnsBindPermission resource that contains the accounts having the consumer DNS bind permission on the corresponding intranet VPC of the consumer project. "name": "A String", # Required. Output only. The name of the resource which stores the users/service accounts having the permission to bind to the corresponding intranet VPC of the consumer project. DnsBindPermission is a global resource and location can only be global. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/global/dnsBindPermission` "principals": [ # Output only. Users/Service accounts which have access for binding on the intranet VPC project corresponding to the consumer project. - { # Users/Service accounts which have access for DNS binding on the intranet VPC corresponding to the consumer project. + { # Users/Service accounts which have access for DNS binding on the intranet VPC corresponding to the consumer project. Principal can be a user or a service account. For example: For specifying user `user@example.com` use `{"user": "user@example.com"}` and for specifying service account `service-account@gserviceaccount.com` use `{"serviceAccount": "service-account@gserviceaccount.com"}`. "serviceAccount": "A String", # The service account which needs to be granted the permission. "user": "A String", # The user who needs to be granted permission. }, diff --git a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.clusters.html b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.clusters.html index fe719b3e03..ae52df2b78 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.clusters.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.clusters.html @@ -186,8 +186,8 @@

Method Details

}, "state": "A String", # Output only. State of the resource. "stretchedClusterConfig": { # Configuration of a stretched cluster. # Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud. - "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` where `{project}` can either be a project number or a project ID. - "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. + "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` or `europe-west3-a`, where `{project}` can either be a project number or a project ID. + "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` or `europe-west3-b`, where `{project}` can either be a project number or a project ID. }, "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. @@ -331,8 +331,8 @@

Method Details

}, "state": "A String", # Output only. State of the resource. "stretchedClusterConfig": { # Configuration of a stretched cluster. # Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud. - "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` where `{project}` can either be a project number or a project ID. - "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. + "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` or `europe-west3-a`, where `{project}` can either be a project number or a project ID. + "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` or `europe-west3-b`, where `{project}` can either be a project number or a project ID. }, "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. @@ -463,8 +463,8 @@

Method Details

}, "state": "A String", # Output only. State of the resource. "stretchedClusterConfig": { # Configuration of a stretched cluster. # Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud. - "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` where `{project}` can either be a project number or a project ID. - "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. + "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` or `europe-west3-a`, where `{project}` can either be a project number or a project ID. + "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` or `europe-west3-b`, where `{project}` can either be a project number or a project ID. }, "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. @@ -615,8 +615,8 @@

Method Details

}, "state": "A String", # Output only. State of the resource. "stretchedClusterConfig": { # Configuration of a stretched cluster. # Optional. Configuration of a stretched cluster. Required for clusters that belong to a STRETCHED private cloud. - "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` where `{project}` can either be a project number or a project ID. - "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. + "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` or `europe-west3-a`, where `{project}` can either be a project number or a project ID. + "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` or `europe-west3-b`, where `{project}` can either be a project number or a project ID. }, "uid": "A String", # Output only. System-generated unique identifier for the resource. "updateTime": "A String", # Output only. Last update time of this resource. diff --git a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html index 450d23bdfa..5850b8284b 100644 --- a/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html +++ b/docs/dyn/vmwareengine_v1.projects.locations.privateClouds.html @@ -138,7 +138,7 @@

Instance Methods

Migrates the management VMs of the PC from the current management cluster to a workload cluster. Post this migration, the provided workload cluster becomes the management cluster

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

-

Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

+

Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`, `encryption_config`. If `updateMask` is provided, only fields specified in it are applied. If `updateMask` is not provided, the default behavior is to update the `description`. It is advised to provide an `updateMask` to avoid confusion. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.

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

Accelerates the deletion of a private cloud that is currently in soft deletion A `PrivateCloud` resource in soft deletion has `PrivateCloud.state` set to `SOFT_DELETED` and `PrivateCloud.expireTime` set to the time when deletion can no longer be reversed.

@@ -205,8 +205,8 @@

Method Details

}, }, "stretchedClusterConfig": { # Configuration of a stretched cluster. # Optional. Configuration of a stretched cluster. Required for STRETCHED private clouds. - "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` where `{project}` can either be a project number or a project ID. - "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. + "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` or `europe-west3-a`, where `{project}` can either be a project number or a project ID. + "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` or `europe-west3-b`, where `{project}` can either be a project number or a project ID. }, }, "name": "A String", # Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` @@ -343,8 +343,8 @@

Method Details

}, }, "stretchedClusterConfig": { # Configuration of a stretched cluster. # Optional. Configuration of a stretched cluster. Required for STRETCHED private clouds. - "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` where `{project}` can either be a project number or a project ID. - "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. + "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` or `europe-west3-a`, where `{project}` can either be a project number or a project ID. + "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` or `europe-west3-b`, where `{project}` can either be a project number or a project ID. }, }, "name": "A String", # Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` @@ -496,8 +496,8 @@

Method Details

}, }, "stretchedClusterConfig": { # Configuration of a stretched cluster. # Optional. Configuration of a stretched cluster. Required for STRETCHED private clouds. - "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` where `{project}` can either be a project number or a project ID. - "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. + "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` or `europe-west3-a`, where `{project}` can either be a project number or a project ID. + "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` or `europe-west3-b`, where `{project}` can either be a project number or a project ID. }, }, "name": "A String", # Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` @@ -592,7 +592,7 @@

Method Details

patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None) -
Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
+  
Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`, `encryption_config`. If `updateMask` is provided, only fields specified in it are applied. If `updateMask` is not provided, the default behavior is to update the `description`. It is advised to provide an `updateMask` to avoid confusion. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.
 
 Args:
   name: string, Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` (required)
@@ -623,8 +623,8 @@ 

Method Details

}, }, "stretchedClusterConfig": { # Configuration of a stretched cluster. # Optional. Configuration of a stretched cluster. Required for STRETCHED private clouds. - "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` where `{project}` can either be a project number or a project ID. - "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID. + "preferredLocation": "A String", # Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` or `europe-west3-a`, where `{project}` can either be a project number or a project ID. + "secondaryLocation": "A String", # Required. Additional zone for a higher level of availability and load balancing. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` or `europe-west3-b`, where `{project}` can either be a project number or a project ID. }, }, "name": "A String", # Output only. Identifier. The resource name of this private cloud. Resource names are schemeless URIs that follow the conventions in https://cloud.google.com/apis/design/resource_names. For example: `projects/my-project/locations/us-central1-a/privateClouds/my-cloud` @@ -654,7 +654,7 @@

Method Details

} requestId: string, Optional. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000). - updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the `PrivateCloud` resource by the update. The fields specified in `updateMask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten. + updateMask: string, Required. Field mask is used to specify the fields to be overwritten in the `PrivateCloud` resource by the update. The fields specified in `updateMask` 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 only the description field will be overwritten. validateOnly: boolean, Optional. If set to `true`, only validates the request but doesn’t execute the request. If set to `false`, validates and executes the request. x__xgafv: string, V1 error format. Allowed values diff --git a/docs/dyn/youtube_v3.commentThreads.html b/docs/dyn/youtube_v3.commentThreads.html index 35078819d3..4102d5f910 100644 --- a/docs/dyn/youtube_v3.commentThreads.html +++ b/docs/dyn/youtube_v3.commentThreads.html @@ -120,6 +120,7 @@

Method Details

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. "canRate": True or False, # Whether the current viewer can rate this comment. "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. + "imageUrl": "A String", # Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval. "likeCount": 42, # The total number of likes this comment has received. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "parentId": "A String", # The unique id of the top-level comment, only set for replies. @@ -150,6 +151,7 @@

Method Details

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. "canRate": True or False, # Whether the current viewer can rate this comment. "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. + "imageUrl": "A String", # Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval. "likeCount": 42, # The total number of likes this comment has received. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "parentId": "A String", # The unique id of the top-level comment, only set for replies. @@ -193,6 +195,7 @@

Method Details

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. "canRate": True or False, # Whether the current viewer can rate this comment. "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. + "imageUrl": "A String", # Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval. "likeCount": 42, # The total number of likes this comment has received. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "parentId": "A String", # The unique id of the top-level comment, only set for replies. @@ -223,6 +226,7 @@

Method Details

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. "canRate": True or False, # Whether the current viewer can rate this comment. "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. + "imageUrl": "A String", # Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval. "likeCount": 42, # The total number of likes this comment has received. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "parentId": "A String", # The unique id of the top-level comment, only set for replies. @@ -300,6 +304,7 @@

Method Details

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. "canRate": True or False, # Whether the current viewer can rate this comment. "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. + "imageUrl": "A String", # Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval. "likeCount": 42, # The total number of likes this comment has received. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "parentId": "A String", # The unique id of the top-level comment, only set for replies. @@ -330,6 +335,7 @@

Method Details

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. "canRate": True or False, # Whether the current viewer can rate this comment. "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. + "imageUrl": "A String", # Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval. "likeCount": 42, # The total number of likes this comment has received. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "parentId": "A String", # The unique id of the top-level comment, only set for replies. diff --git a/docs/dyn/youtube_v3.comments.html b/docs/dyn/youtube_v3.comments.html index b2199f9eb4..927786c779 100644 --- a/docs/dyn/youtube_v3.comments.html +++ b/docs/dyn/youtube_v3.comments.html @@ -139,6 +139,7 @@

Method Details

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. "canRate": True or False, # Whether the current viewer can rate this comment. "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. + "imageUrl": "A String", # Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval. "likeCount": 42, # The total number of likes this comment has received. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "parentId": "A String", # The unique id of the top-level comment, only set for replies. @@ -172,6 +173,7 @@

Method Details

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. "canRate": True or False, # Whether the current viewer can rate this comment. "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. + "imageUrl": "A String", # Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval. "likeCount": 42, # The total number of likes this comment has received. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "parentId": "A String", # The unique id of the top-level comment, only set for replies. @@ -225,6 +227,7 @@

Method Details

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. "canRate": True or False, # Whether the current viewer can rate this comment. "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. + "imageUrl": "A String", # Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval. "likeCount": 42, # The total number of likes this comment has received. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "parentId": "A String", # The unique id of the top-level comment, only set for replies. @@ -318,6 +321,7 @@

Method Details

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. "canRate": True or False, # Whether the current viewer can rate this comment. "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. + "imageUrl": "A String", # Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval. "likeCount": 42, # The total number of likes this comment has received. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "parentId": "A String", # The unique id of the top-level comment, only set for replies. @@ -351,6 +355,7 @@

Method Details

"authorProfileImageUrl": "A String", # The URL for the avatar of the user who posted the comment. "canRate": True or False, # Whether the current viewer can rate this comment. "channelId": "A String", # The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel. + "imageUrl": "A String", # Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval. "likeCount": 42, # The total number of likes this comment has received. "moderationStatus": "A String", # The comment's moderation status. Will not be set if the comments were requested through the id filter. "parentId": "A String", # The unique id of the top-level comment, only set for replies. diff --git a/googleapiclient/discovery_cache/documents/analyticshub.v1.json b/googleapiclient/discovery_cache/documents/analyticshub.v1.json index 04023e4b11..39c143ed70 100644 --- a/googleapiclient/discovery_cache/documents/analyticshub.v1.json +++ b/googleapiclient/discovery_cache/documents/analyticshub.v1.json @@ -1247,7 +1247,7 @@ } } }, -"revision": "20260921", +"revision": "20260926", "rootUrl": "https://analyticshub.googleapis.com/", "schemas": { "AIInference": { @@ -1515,7 +1515,7 @@ }, "rowKeySchema": { "$ref": "RowKeySchema", -"description": "Optional. If set, the row key is constructed from the field names of the table's structured row key (https://docs.cloud.google.com/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead." +"description": "Optional. If set, the row key is constructed from the field names of the table's [structured row key](https://cloud.google.com/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; `null` will be used instead." } }, "type": "object" @@ -1970,7 +1970,7 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\" See https://{$universe.dns_names.final_documentation_domain}/pubsub/docs/tags for more information on using tags with Pub/Sub resources.", +"description": "Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: \"123/environment\": \"production\", \"123/costCenter\": \"marketing\" See [Create and manage tags](https://cloud.google.com/pubsub/docs/tags) for more information on using tags with Pub/Sub resources.", "type": "object" } }, @@ -2749,7 +2749,7 @@ "type": "object" }, "RowKeySchema": { -"description": "Row key definition that reads the input message fields based on the field names of the table's structured row key (https://docs.cloud.google.com/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; null will be used instead.", +"description": "Row key definition that reads the input message fields based on the field names of the table's [structured row key](https://cloud.google.com/bigtable/docs/manage-row-key-schemas). Note that if the field is nullable in the structured row key, then it need not be present in the message; `null` will be used instead.", "id": "RowKeySchema", "properties": {}, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/chat.v1.json b/googleapiclient/discovery_cache/documents/chat.v1.json index 4235d39730..232db7c384 100644 --- a/googleapiclient/discovery_cache/documents/chat.v1.json +++ b/googleapiclient/discovery_cache/documents/chat.v1.json @@ -72,10 +72,10 @@ "description": "View members in Google Chat conversations." }, "https://www.googleapis.com/auth/chat.messages": { -"description": "See, compose, send, update, and delete messages as well as their message content; add, see, and delete reactions to messages." +"description": "See, compose, send, update, and delete messages, their content, and attached cards; add, see, and delete reactions to messages." }, "https://www.googleapis.com/auth/chat.messages.create": { -"description": "Compose and send messages in Google Chat" +"description": "Compose and send messages and attach cards" }, "https://www.googleapis.com/auth/chat.messages.reactions": { "description": "See, add, and delete reactions as well as their reaction content to messages in Google Chat" @@ -2181,7 +2181,7 @@ } } }, -"revision": "20260920", +"revision": "20260927", "rootUrl": "https://chat.googleapis.com/", "schemas": { "AccessPermissionSetting": { @@ -6643,7 +6643,7 @@ "id": "SpaceDetails", "properties": { "description": { -"description": "Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 150 characters.", +"description": "Optional. A description of the space. For example, describe the space's discussion topic, functional purpose, or participants. Supports up to 4,096 characters.", "type": "string" }, "guidelines": { diff --git a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json index e79e0a14c1..c4e6215824 100644 --- a/googleapiclient/discovery_cache/documents/chromemanagement.v1.json +++ b/googleapiclient/discovery_cache/documents/chromemanagement.v1.json @@ -2557,7 +2557,7 @@ } } }, -"revision": "20260924", +"revision": "20260930", "rootUrl": "https://chromemanagement.googleapis.com/", "schemas": { "GoogleChromeManagementV1AndroidAppInfo": { @@ -5187,14 +5187,14 @@ false ], "enumDeprecated": [ false, -false, +true, true, false, false ], "enumDescriptions": [ "Default value when no provider is specified.", -"CRXcavator.", +"Deprecated: Please use other risk score providers instead. CRXcavator.", "Deprecated: Please use RISK_ASSESSMENT_PROVIDER_SPIN_AI_V2 instead. Spin.Ai.", "LayerX Security.", "Spin.AI V2." diff --git a/googleapiclient/discovery_cache/documents/cloudproductregistry.v1.json b/googleapiclient/discovery_cache/documents/cloudproductregistry.v1.json index 1ecd75938d..489d2f1ee0 100644 --- a/googleapiclient/discovery_cache/documents/cloudproductregistry.v1.json +++ b/googleapiclient/discovery_cache/documents/cloudproductregistry.v1.json @@ -329,7 +329,7 @@ } } }, -"revision": "20260805", +"revision": "20260929", "rootUrl": "https://cloudproductregistry.googleapis.com/", "schemas": { "ListLogicalProductVariantsResponse": { @@ -399,10 +399,17 @@ "LIFECYCLE_STATE_GA", "LIFECYCLE_STATE_DEPRECATED" ], +"enumDeprecated": [ +false, +false, +true, +false, +false +], "enumDescriptions": [ "The default value. This value is used if the lifecycle state is not set.", "The entity is in Public Preview. It is available to all customers, but may not be feature-complete or have full support guarantees.", -"The entity is in Private General Availability. It is fully supported and stable, but only available to a select group of customers.", +"Deprecated: Private General Availability entities are not exposed. The entity is in Private General Availability. It is fully supported and stable, but only available to a select group of customers.", "The entity is Generally Available. It is fully supported, stable, and available to all customers.", "The entity is deprecated. It is no longer recommended for use and may be removed in a future version." ], @@ -455,10 +462,17 @@ "LIFECYCLE_STATE_GA", "LIFECYCLE_STATE_DEPRECATED" ], +"enumDeprecated": [ +false, +false, +true, +false, +false +], "enumDescriptions": [ "The default value. This value is used if the lifecycle state is not set.", "The entity is in Public Preview. It is available to all customers, but may not be feature-complete or have full support guarantees.", -"The entity is in Private General Availability. It is fully supported and stable, but only available to a select group of customers.", +"Deprecated: Private General Availability entities are not exposed. The entity is in Private General Availability. It is fully supported and stable, but only available to a select group of customers.", "The entity is Generally Available. It is fully supported, stable, and available to all customers.", "The entity is deprecated. It is no longer recommended for use and may be removed in a future version." ], diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json index 35c201ec8e..7dd2dae305 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2.json @@ -824,7 +824,7 @@ } } }, -"revision": "20260820", +"revision": "20260927", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -940,7 +940,7 @@ "description": "The issue classification applicable to this case." }, "contactEmail": { -"description": "A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs.", +"description": "A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field.", "type": "string" }, "createTime": { @@ -951,7 +951,7 @@ }, "creator": { "$ref": "Actor", -"description": "The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support." +"description": "The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support." }, "description": { "description": "A broad description of the issue.", diff --git a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json index d5128d1100..33f6ad6c51 100644 --- a/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json +++ b/googleapiclient/discovery_cache/documents/cloudsupport.v2beta.json @@ -891,7 +891,7 @@ } } }, -"revision": "20260820", +"revision": "20260927", "rootUrl": "https://cloudsupport.googleapis.com/", "schemas": { "Actor": { @@ -1007,7 +1007,7 @@ "description": "The issue classification applicable to this case." }, "contactEmail": { -"description": "A user-supplied email address to send case update notifications for. This should only be used in BYOID flows, where we cannot infer the user's email address directly from their EUCs.", +"description": "A user-supplied email address to send case update notifications for. This field must be set when the request is authenticated using a Workforce Identity Federation (BYOID) flow and must not be set otherwise. When unset, the contact email is inferred from the authenticated user's credentials. If you use a service account to create the case and its inferred email address cannot receive emails, you should add appropriate contact emails in the `subscriber_email_addresses` field.", "type": "string" }, "createTime": { @@ -1018,7 +1018,7 @@ }, "creator": { "$ref": "Actor", -"description": "The user who created the case. Note: The name and email will be obfuscated if the case was created by Google Support." +"description": "The user who created the case. This field is ignored on input. Note: The name and email will be obfuscated if the case was created by Google Support." }, "description": { "description": "A broad description of the issue.", diff --git a/googleapiclient/discovery_cache/documents/container.v1.json b/googleapiclient/discovery_cache/documents/container.v1.json index b896eb7ae0..39f82d3517 100644 --- a/googleapiclient/discovery_cache/documents/container.v1.json +++ b/googleapiclient/discovery_cache/documents/container.v1.json @@ -2811,7 +2811,7 @@ } } }, -"revision": "20260901", +"revision": "20260922", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3719,7 +3719,7 @@ }, "costManagementConfig": { "$ref": "CostManagementConfig", -"description": "Configuration for the fine-grained cost management feature." +"description": "Configuration for the fine-grained cost allocation feature." }, "createTime": { "description": "Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", @@ -4245,7 +4245,7 @@ }, "desiredCostManagementConfig": { "$ref": "CostManagementConfig", -"description": "The desired configuration for the fine-grained cost management feature." +"description": "The desired configuration for the fine-grained cost allocation feature." }, "desiredDatabaseEncryption": { "$ref": "DatabaseEncryption", @@ -4846,7 +4846,7 @@ "type": "object" }, "CostManagementConfig": { -"description": "Configuration for fine-grained cost management feature.", +"description": "Configuration for fine-grained cost allocation feature.", "id": "CostManagementConfig", "properties": { "enabled": { @@ -9031,11 +9031,13 @@ false "description": "Type of the sandbox to use for the node.", "enum": [ "UNSPECIFIED", -"GVISOR" +"GVISOR", +"MICROVM" ], "enumDescriptions": [ "Default value. This should not be used.", -"Run sandbox using gvisor." +"Run sandbox using gvisor.", +"Run sandbox using MicroVM." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/container.v1beta1.json b/googleapiclient/discovery_cache/documents/container.v1beta1.json index 663dc43f8f..662e0700cf 100644 --- a/googleapiclient/discovery_cache/documents/container.v1beta1.json +++ b/googleapiclient/discovery_cache/documents/container.v1beta1.json @@ -2837,7 +2837,7 @@ } } }, -"revision": "20260901", +"revision": "20260922", "rootUrl": "https://container.googleapis.com/", "schemas": { "AcceleratorConfig": { @@ -3835,7 +3835,7 @@ }, "costManagementConfig": { "$ref": "CostManagementConfig", -"description": "Configuration for the fine-grained cost management feature." +"description": "Configuration for the fine-grained cost allocation feature." }, "createTime": { "description": "Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", @@ -4428,7 +4428,7 @@ }, "desiredCostManagementConfig": { "$ref": "CostManagementConfig", -"description": "The desired configuration for the fine-grained cost management feature." +"description": "The desired configuration for the fine-grained cost allocation feature." }, "desiredDatabaseEncryption": { "$ref": "DatabaseEncryption", @@ -5089,7 +5089,7 @@ "type": "object" }, "CostManagementConfig": { -"description": "Configuration for fine-grained cost management feature.", +"description": "Configuration for fine-grained cost allocation feature.", "id": "CostManagementConfig", "properties": { "enabled": { @@ -9544,11 +9544,13 @@ false "description": "Type of the sandbox to use for the node.", "enum": [ "UNSPECIFIED", -"GVISOR" +"GVISOR", +"MICROVM" ], "enumDescriptions": [ "Default value. This should not be used.", -"Run sandbox using gvisor." +"Run sandbox using gvisor.", +"Run sandbox using MicroVM." ], "type": "string" } diff --git a/googleapiclient/discovery_cache/documents/css.v1.json b/googleapiclient/discovery_cache/documents/css.v1.json index 09059aee73..71a6b58395 100644 --- a/googleapiclient/discovery_cache/documents/css.v1.json +++ b/googleapiclient/discovery_cache/documents/css.v1.json @@ -547,7 +547,7 @@ } } }, -"revision": "20260713", +"revision": "20260930", "rootUrl": "https://css.googleapis.com/", "schemas": { "Account": { @@ -822,12 +822,12 @@ "type": "string" }, "maxRating": { -"description": "Maximum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used.", +"description": "Maximum rating score of the product. Required if `rating` is provided.", "format": "int64", "type": "string" }, "minRating": { -"description": "Minimum rating score of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used.", +"description": "Minimum rating score of the product. Required if `rating` is provided.", "format": "int64", "type": "string" }, @@ -891,12 +891,12 @@ "description": "The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive)." }, "rating": { -"description": "Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required. This field is for an upcoming feature and is not yet used.", +"description": "Average rating score of the product. The value must be within the range of [`min_rating`, `max_rating`], inclusive. When displayed on the product page, this rating is normalized to a scale of [1, 5] with one decimal place. If provided, `review_count`, `min_rating`, and `max_rating` are also required.", "format": "double", "type": "number" }, "reviewCount": { -"description": "Number of reviews of the product. Required if `rating` is provided. This field is for an upcoming feature and is not yet used.", +"description": "Number of reviews of the product. Required if `rating` is provided.", "format": "int64", "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json b/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json index 92373a2d3e..23b3f9d050 100644 --- a/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json +++ b/googleapiclient/discovery_cache/documents/databasecenter.v1beta.json @@ -364,7 +364,7 @@ } } }, -"revision": "20260710", +"revision": "20260930", "rootUrl": "https://databasecenter.googleapis.com/", "schemas": { "AdditionalDetail": { @@ -2083,11 +2083,11 @@ false "id": "QueryDatabaseResourceGroupsRequest", "properties": { "filter": { -"description": "Optional. The expression to filter resources. The following fields are filterable: * full_resource_name * resource_type * container * product.type * product.engine * product.version * location * labels * resource_category * machine_config.cpu_count * machine_config.memory_size_bytes * machine_config.shard_count * resource_name * tags * backupdr_config.backupdr_managed * edition The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. When `AND` and `OR` are both used in the expression, parentheses must be appropriately used to group the combinations. Example: `location=\"us-east1\"` Example: `container=\"projects/123\" OR container=\"projects/456\"` Example: `(container=\"projects/123\" OR container=\"projects/456\") AND location=\"us-east1\"` Example: `full_resource_name=~\"test\"` Example: `full_resource_name=~\"test.*master\"`", +"description": "Optional. The expression to filter resources. The following fields are filterable: * full_resource_name * resource_type * container * product.type * product.engine * product.version * location * labels * resource_category * machine_config.cpu_count * machine_config.memory_size_bytes * machine_config.shard_count * resource_name * tags * backupdr_config.backupdr_managed * edition * modes The expression is a list of zero or more restrictions combined via logical operators `AND` and `OR`. When `AND` and `OR` are both used in the expression, parentheses must be appropriately used to group the combinations. Example: `location=\"us-east1\"` Example: `container=\"projects/123\" OR container=\"projects/456\"` Example: `(container=\"projects/123\" OR container=\"projects/456\") AND location=\"us-east1\"` Example: `full_resource_name=~\"test\"` Example: `full_resource_name=~\"test.*master\"`", "type": "string" }, "orderBy": { -"description": "Optional. A field that specifies the sort order of the results. The following fields are sortable: * full_resource_name * product.type * product.engine * product.version * container * issue_count * machine_config.vcpu_count * machine_config.memory_size_bytes * machine_config.shard_count * resource_name * issue_severity * signal_type * location * resource_type * instance_type * edition * metrics.p99_cpu_utilization * metrics.p95_cpu_utilization * metrics.current_storage_used_bytes * metrics.node_count * metrics.processing_unit_count * metrics.current_memory_used_bytes * metrics.peak_storage_utilization * metrics.peak_number_connections * metrics.peak_memory_utilization The default order is ascending. Add \"DESC\" after the field name to indicate descending order. Add \"ASC\" after the field name to indicate ascending order. It only supports a single field at a time. For example: `order_by = \"full_resource_name\"` sorts response in ascending order `order_by = \"full_resource_name DESC\"` sorts response in descending order `order_by = \"issue_count DESC\"` sorts response in descending order of count of all issues associated with a resource. More explicitly, `order_by = \"full_resource_name, product\"` is not supported.", +"description": "Optional. A field that specifies the sort order of the results. The following fields are sortable: * full_resource_name * product.type * product.engine * product.version * container * issue_count * machine_config.vcpu_count * machine_config.memory_size_bytes * machine_config.shard_count * resource_name * issue_severity * signal_type * location * resource_type * instance_type * edition * modes * metrics.p99_cpu_utilization * metrics.p95_cpu_utilization * metrics.current_storage_used_bytes * metrics.node_count * metrics.processing_unit_count * metrics.current_memory_used_bytes * metrics.peak_storage_utilization * metrics.peak_number_connections * metrics.peak_memory_utilization The default order is ascending. Add \"DESC\" after the field name to indicate descending order. Add \"ASC\" after the field name to indicate ascending order. It only supports a single field at a time. For example: `order_by = \"full_resource_name\"` sorts response in ascending order `order_by = \"full_resource_name DESC\"` sorts response in descending order `order_by = \"issue_count DESC\"` sorts response in descending order of count of all issues associated with a resource. More explicitly, `order_by = \"full_resource_name, product\"` is not supported.", "type": "string" }, "pageSize": { diff --git a/googleapiclient/discovery_cache/documents/devicerun.v1alpha.json b/googleapiclient/discovery_cache/documents/devicerun.v1alpha.json index b7eb0f7af8..15548e3d86 100644 --- a/googleapiclient/discovery_cache/documents/devicerun.v1alpha.json +++ b/googleapiclient/discovery_cache/documents/devicerun.v1alpha.json @@ -657,7 +657,7 @@ } } }, -"revision": "20260923", +"revision": "20261001", "rootUrl": "https://devicerun.googleapis.com/", "schemas": { "AllocationConfig": { @@ -852,7 +852,7 @@ "description": "Required. The file path of the Android native binary." }, "args": { -"description": "Optional. Arguments for running the binary file. The flags will be appended to the command line that invokes the binary. The number of options is limited to 100.", +"description": "Optional. Arguments for running the binary file. The flags will be appended to the command line that invokes the binary. Limits: - Maximum number of entries: 64 - Maximum entry size: 1024 bytes (UTF-8)", "items": { "type": "string" }, @@ -862,7 +862,7 @@ "additionalProperties": { "type": "string" }, -"description": "Optional. A map of environment variables to set for the binary process. The keys are the variable names and the values are the variable values. The maximum number of entries is 100. Each key is limited to 128 characters and must conform to POSIX standards. Each value is limited to 2048 characters. The total size of all environment variables must not exceed 16 KiB.", +"description": "Optional. A map of environment variables to set for the binary process. The keys are the variable names and the values are the variable values. Limits: - Maximum number of entries: 32 - Maximum key size: 64 bytes (UTF-8) - Key regex: `a-zA-Z_*` - Maximum value size: 1024 bytes (UTF-8)", "type": "object" }, "executionTimeout": { diff --git a/googleapiclient/discovery_cache/documents/fcm.v1.json b/googleapiclient/discovery_cache/documents/fcm.v1.json index 55f9abc789..68839caeff 100644 --- a/googleapiclient/discovery_cache/documents/fcm.v1.json +++ b/googleapiclient/discovery_cache/documents/fcm.v1.json @@ -113,7 +113,7 @@ "messages": { "methods": { "send": { -"description": "Send a message to specified target (a [Firebase Installation ID (FID)](/docs/cloud-messaging/android/get-started#access-firebase-installation-id), registration token, topic, or condition).", +"description": "Send a message to specified target (a [Firebase Installation ID (FID)](/docs/cloud-messaging/android/get-started#access-firebase-installation-id), registration token, topic, or condition). If duplicate fields or parameters are provided in a request (such as repeated JSON keys in the request body or duplicate query parameters), the last occurrence takes precedence.", "flatPath": "v1/projects/{projectsId}/messages:send", "httpMethod": "POST", "id": "fcm.projects.messages.send", @@ -316,7 +316,7 @@ } } }, -"revision": "20260911", +"revision": "20260925", "rootUrl": "https://fcm.googleapis.com/", "schemas": { "AndroidConfig": { diff --git a/googleapiclient/discovery_cache/documents/firestore.v1.json b/googleapiclient/discovery_cache/documents/firestore.v1.json index 44503fc6d9..d188b69c7d 100644 --- a/googleapiclient/discovery_cache/documents/firestore.v1.json +++ b/googleapiclient/discovery_cache/documents/firestore.v1.json @@ -2602,7 +2602,7 @@ } } }, -"revision": "20260826", +"revision": "20260928", "rootUrl": "https://firestore.googleapis.com/", "schemas": { "Aggregation": { @@ -4442,7 +4442,7 @@ "description": "Optional. Options for search indexes that are at the index definition level. This field is only currently supported for indexes with MONGODB_COMPATIBLE_API ApiScope." }, "shardCount": { -"description": "Optional. The number of shards for the index.", +"description": "Optional. The number of physical shards for the index. In Cloud Firestore, data and index entries are stored in contiguous, ordered key ranges called splits. While document keys within a collection are hashed to distribute write traffic across splits, secondary index entries are ordered lexicographically by their indexed field values. When an index contains fields with sequential or monotonically increasing or decreasing values (such as timestamps or auto-incrementing IDs), every incoming index write targets the boundary of the index keyspace on a single split. Because sequential writes continuously advance to the newest split at the edge of the range, automatic load-based splitting cannot divide the write traffic across storage servers. Under high write rates, this concentration creates an append hotspot on that single split, resulting in elevated write latency, contention errors, and transaction aborts. Sharded indexes solve this write bottleneck by hash partitioning the secondary index keyspace. When `shard_count` is configured to N, Firestore automatically prepends a virtual computed shard field (with values from 0 to N-1) as the leading field of the index. This splits a single sequential key range into N independent key ranges, uniformly scattering adjacent writes across distinct splits and storage servers to enable linear write scaling. Query trade-offs: Hash partitioning trades query performance for write throughput. Because matching index entries are scattered across all shards, queries executing against a sharded index cannot read from a single contiguous range. The query engine must fan out parallel seeks across all N shards and merge the ordered results. Even index point lookups and queries with `LIMIT 1` must seek across all N shards. Sizing and best practices: - Indexes cannot be updated in-place. `shard_count` is immutable once an index is created; to \"reshard\" an index, create a new index with the desired `shard_count` and delete the original index. - Use sharded indexes only for indexes experiencing write bottlenecks (typically exceeding 500-1,000 writes/sec) on sequential or timestamp fields. - Do not shard indexes on uniformly distributed fields (such as UUIDs or hash tokens), where writes naturally spread across splits without sharding. Sharding uniform indexes adds query overhead without improving write throughput. - Do not shard read-heavy or low-write collections. - Size `shard_count` based on expected peak write throughput. Because a single split sustains roughly 500-1,000 writes/sec on sequential keys, estimate `shard_count \u2248 ceil(peak_write_qps / 500)`. - e.g., 4 for up to ~2,000-4,000 writes/sec, 16 for up to ~10,000+ writes/sec. - Setting an excessively high shard count produces diminishing write returns while needlessly increasing read latency and seek costs. If <= 1, the index is unsharded (1 physical shard).", "format": "int32", "type": "integer" }, diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json index acb0179f7a..2c1617ba66 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1.json @@ -2438,7 +2438,7 @@ } } }, -"revision": "20260924", +"revision": "20260930", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -4922,7 +4922,7 @@ false "type": "object" }, "Program": { -"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `ucp-integration` (limited access) * `youtube-affiliate` * `youtube-shopping-checkout`", +"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * [`checkout`](https://developers.google.com/merchant/api/guides/products/checkout-settings) * `free-listings` * [`loyalty`](https://developers.google.com/merchant/api/guides/loyalty/loyalty-programs) * `product-ratings` * `shopping-ads` * [`ucp-integration` (limited access)](https://developers.google.com/merchant/api/reference/rest/accounts_v1alpha/accounts.programs.ucpSettings) * [`youtube-affiliate`](https://support.google.com/merchants/answer/14815513) * `youtube-shopping-checkout`", "id": "Program", "properties": { "activeRegionCodes": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json index ee0ff586a6..dbef4a22d1 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.accounts_v1beta.json @@ -2388,7 +2388,7 @@ } } }, -"revision": "20260924", +"revision": "20260930", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "About": { @@ -4799,7 +4799,7 @@ false "type": "object" }, "Program": { -"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * `checkout` * `free-listings` * `product-ratings` * `shopping-ads` * `ucp-integration` (limited access) * `youtube-affiliate` * `youtube-shopping-checkout`", +"description": "Defines participation in a given program for the specified account. Programs provide a mechanism for adding functionality to a Merchant Center accounts. A typical example of this is the [Free product listings](https://support.google.com/merchants/answer/13889434) program, which enables products from a business's store to be shown across Google for free. The following list is the available set of program resource IDs accessible through the API: * [`checkout`](https://developers.google.com/merchant/api/guides/products/checkout-settings) * `free-listings` * [`loyalty`](https://developers.google.com/merchant/api/guides/loyalty/loyalty-programs) * `product-ratings` * `shopping-ads` * [`ucp-integration` (limited access)](https://developers.google.com/merchant/api/reference/rest/accounts_v1alpha/accounts.programs.ucpSettings) * [`youtube-affiliate`](https://support.google.com/merchants/answer/14815513) * `youtube-shopping-checkout`", "id": "Program", "properties": { "activeRegionCodes": { diff --git a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json index afb15172fe..08c4beea89 100644 --- a/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json +++ b/googleapiclient/discovery_cache/documents/merchantapi.products_v1.json @@ -281,7 +281,7 @@ } } }, -"revision": "20260921", +"revision": "20261002", "rootUrl": "https://merchantapi.googleapis.com/", "schemas": { "AutomatedDiscounts": { @@ -2590,14 +2590,16 @@ false "ADEME", "BMWK", "EPA", -"EC" +"EC", +"DESNZ" ], "enumDescriptions": [ "Certification authority is not specified.", "For the French CO2 emissions class for vehicles.", "For the German CO2 emissions classes for vehicles.", "Environment Protection Agency.", -"European Commission for energy labels in the EU." +"European Commission for energy labels in the EU.", +"Department for Energy Security and Net Zero." ], "type": "string" }, @@ -2622,7 +2624,8 @@ false "EPREL", "EU_ECOLABEL", "VEHICLE_ENERGY_EFFICIENCY", -"VEHICLE_ENERGY_EFFICIENCY_DISCHARGED_BATTERY" +"VEHICLE_ENERGY_EFFICIENCY_DISCHARGED_BATTERY", +"GB_ENERGY_INFO" ], "enumDescriptions": [ "Certification name is not specified.", @@ -2631,7 +2634,8 @@ false "Represents energy efficiency certifications in the EU European Registry for Energy Labeling (EPREL) database.", "EU Ecolabel.", "The overall CO2 class of a vehicle", -"For the CO2 class of a vehicle with a discharged battery." +"For the CO2 class of a vehicle with a discharged battery.", +"Great Britain Energy Information." ], "type": "string" }, diff --git a/googleapiclient/discovery_cache/documents/run.v1.json b/googleapiclient/discovery_cache/documents/run.v1.json index 19798d5a63..04bcdb80a5 100644 --- a/googleapiclient/discovery_cache/documents/run.v1.json +++ b/googleapiclient/discovery_cache/documents/run.v1.json @@ -3652,7 +3652,7 @@ } } }, -"revision": "20260917", +"revision": "20260925", "rootUrl": "https://run.googleapis.com/", "schemas": { "Addressable": { @@ -4158,11 +4158,11 @@ "type": "object" }, "EmptyDirVolumeSource": { -"description": "In memory (tmpfs) ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs).", +"description": "In memory or disk-backed ephemeral storage. It is ephemeral in the sense that when the sandbox is taken down, the data is destroyed with it (it does not persist across sandbox runs).", "id": "EmptyDirVolumeSource", "properties": { "medium": { -"description": "The medium on which the data is stored. The default is \"\" which means to use the node's default medium. Must be an empty string (default) or Memory. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", +"description": "The medium on which the data is stored. The default is \"\" which means to use the node's default medium. Must be an empty string (default), `Memory`, or `Disk`. More info: https://kubernetes.io/docs/concepts/storage/volumes#emptydir", "type": "string" }, "sizeLimit": { diff --git a/googleapiclient/discovery_cache/documents/sqladmin.v1.json b/googleapiclient/discovery_cache/documents/sqladmin.v1.json index 3005ba00e5..9e20f44705 100644 --- a/googleapiclient/discovery_cache/documents/sqladmin.v1.json +++ b/googleapiclient/discovery_cache/documents/sqladmin.v1.json @@ -3721,7 +3721,7 @@ } } }, -"revision": "20260908", +"revision": "20260920", "rootUrl": "https://sqladmin.googleapis.com/", "schemas": { "AclEntry": { @@ -10101,7 +10101,7 @@ false "properties": { "startWorkloadReplayContext": { "$ref": "StartWorkloadReplayContext", -"description": "Optional. Contains details about the start workload replay operation." +"description": "Required. Contains details about the start workload replay operation." } }, "type": "object" @@ -10123,7 +10123,7 @@ false "properties": { "stopWorkloadReplayContext": { "$ref": "StopWorkloadReplayContext", -"description": "Optional. Contains details about the stop workload replay operation." +"description": "Required. Contains details about the stop workload replay operation." } }, "type": "object" diff --git a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json index f9ed833de9..cf05410a5a 100644 --- a/googleapiclient/discovery_cache/documents/vmwareengine.v1.json +++ b/googleapiclient/discovery_cache/documents/vmwareengine.v1.json @@ -1608,7 +1608,7 @@ ] }, "patch": { -"description": "Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`. Only fields specified in `updateMask` are applied. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.", +"description": "Modifies a `PrivateCloud` resource. Only the following fields can be updated: `description`, `encryption_config`. If `updateMask` is provided, only fields specified in it are applied. If `updateMask` is not provided, the default behavior is to update the `description`. It is advised to provide an `updateMask` to avoid confusion. During operation processing, the resource is temporarily in the `ACTIVE` state before the operation fully completes. For that period of time, you can't update the resource. Use the operation status to determine when the processing fully completes.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/privateClouds/{privateCloudsId}", "httpMethod": "PATCH", "id": "vmwareengine.projects.locations.privateClouds.patch", @@ -1629,7 +1629,7 @@ "type": "string" }, "updateMask": { -"description": "Required. Field mask is used to specify the fields to be overwritten in the `PrivateCloud` resource by the update. The fields specified in `updateMask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.", +"description": "Required. Field mask is used to specify the fields to be overwritten in the `PrivateCloud` resource by the update. The fields specified in `updateMask` 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 only the description field will be overwritten.", "format": "google-fieldmask", "location": "query", "type": "string" @@ -3742,7 +3742,7 @@ } } }, -"revision": "20260608", +"revision": "20260922", "rootUrl": "https://vmwareengine.googleapis.com/", "schemas": { "AcceleratePrivateCloudDeletionRequest": { @@ -4575,7 +4575,7 @@ "properties": { "principal": { "$ref": "Principal", -"description": "Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project." +"description": "Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project. Principal can be a user or a service account. For example, to specify the user `user@example.com`, use `\"principal\": {\"user\": \"user@example.com\"}` and to specify the service account `service-account@gserviceaccount.com`, use `\"principal\": {\"serviceAccount\": \"service-account@gserviceaccount.com\"}`." }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", @@ -6074,7 +6074,7 @@ "type": "object" }, "Principal": { -"description": "Users/Service accounts which have access for DNS binding on the intranet VPC corresponding to the consumer project.", +"description": "Users/Service accounts which have access for DNS binding on the intranet VPC corresponding to the consumer project. Principal can be a user or a service account. For example: For specifying user `user@example.com` use `{\"user\": \"user@example.com\"}` and for specifying service account `service-account@gserviceaccount.com` use `{\"serviceAccount\": \"service-account@gserviceaccount.com\"}`.", "id": "Principal", "properties": { "serviceAccount": { @@ -6361,7 +6361,7 @@ "properties": { "principal": { "$ref": "Principal", -"description": "Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project." +"description": "Required. The consumer provided user/service account which needs to be granted permission to bind with the intranet VPC corresponding to the consumer project. Principal can be a user or a service account. For example, to specify the user `user@example.com`, use `\"principal\": {\"user\": \"user@example.com\"}` and to specify the service account `service-account@gserviceaccount.com`, use `\"principal\": {\"serviceAccount\": \"service-account@gserviceaccount.com\"}`." }, "requestId": { "description": "Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server guarantees that a request doesn't result in creation of duplicate commitments for at least 60 minutes. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).", @@ -6462,11 +6462,11 @@ "id": "StretchedClusterConfig", "properties": { "preferredLocation": { -"description": "Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` where `{project}` can either be a project number or a project ID.", +"description": "Required. Zone that will remain operational when connection between the two zones is lost. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-a` or `europe-west3-a`, where `{project}` can either be a project number or a project ID.", "type": "string" }, "secondaryLocation": { -"description": "Required. Additional zone for a higher level of availability and load balancing. Specify the resource name of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` where `{project}` can either be a project number or a project ID.", +"description": "Required. Additional zone for a higher level of availability and load balancing. Specify the resource name or ID of a zone that belongs to the region of the private cloud. For example: `projects/{project}/locations/europe-west3-b` or `europe-west3-b`, where `{project}` can either be a project number or a project ID.", "type": "string" } }, diff --git a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json index 0beacb1140..883ff38ba5 100644 --- a/googleapiclient/discovery_cache/documents/workspaceevents.v1.json +++ b/googleapiclient/discovery_cache/documents/workspaceevents.v1.json @@ -39,7 +39,7 @@ "description": "View members in Google Chat conversations." }, "https://www.googleapis.com/auth/chat.messages": { -"description": "See, compose, send, update, and delete messages as well as their message content; add, see, and delete reactions to messages." +"description": "See, compose, send, update, and delete messages, their content, and attached cards; add, see, and delete reactions to messages." }, "https://www.googleapis.com/auth/chat.messages.reactions": { "description": "See, add, and delete reactions as well as their reaction content to messages in Google Chat" @@ -809,7 +809,7 @@ } } }, -"revision": "20260818", +"revision": "20260929", "rootUrl": "https://workspaceevents.googleapis.com/", "schemas": { "Artifact": { diff --git a/googleapiclient/discovery_cache/documents/youtube.v3.json b/googleapiclient/discovery_cache/documents/youtube.v3.json index 24e220e83c..19f8ac1304 100644 --- a/googleapiclient/discovery_cache/documents/youtube.v3.json +++ b/googleapiclient/discovery_cache/documents/youtube.v3.json @@ -4188,7 +4188,7 @@ } } }, -"revision": "20260924", +"revision": "20261001", "rootUrl": "https://youtube.googleapis.com/", "schemas": { "AbuseReport": { @@ -5951,6 +5951,11 @@ false "description": "The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video or post comment it's the video/post's channel.", "type": "string" }, +"imageUrl": { +"description": "Output only. The URL of the image or animated GIF attached to the comment, if any. This property is only present when a comment contains an image or GIF. The URL is served as a signed link with a six-hour time to live (TTL) and expires six hours after retrieval.", +"readOnly": true, +"type": "string" +}, "likeCount": { "description": "The total number of likes this comment has received.", "format": "uint32",